Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial instructions for release #56

Merged
merged 8 commits into from
Aug 29, 2022
Merged

Initial instructions for release #56

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
17b999d
Initial instructions for release
andresrc Jun 9, 2022
2b21ec7
Simplify usage
andresrc Jul 14, 2022
c2b8a42
Add render command and misc fixes
andresrc Jul 18, 2022
375618b
Merge branch 'main' into doc-release
andresrc Aug 17, 2022
351c16a
Address review comments and TODO
andresrc Aug 17, 2022
01c311c
Update docs/usage.md
andresrc Aug 29, 2022
29b0f4e
Update docs/usage.md
andresrc Aug 29, 2022
ea960c9
Merge branch 'main' into doc-release
andresrc Aug 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,38 @@ To be done.

## I'm the release manager

To be done.
> NOTE: This instructions are for the 0.2.0 milestone (when ready). As more features and automation is added the process will become simpler.

### Preparing the changelog

* Wait for the last BC of the release. If another BC is generated after that or a patch version for a previous minor is released, you might need to restart the process.
* Create a branch from the commit of the BC.
* From the root folder of the repository run:

```
$ elastic-agent-changelog-tool build --version x.y.z --owner <owner> --repo <repo>
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@endorama @LucianPy if there any default value for owner ? If not, should we make elastic the default value?

Copy link
Member

@endorama endorama Aug 1, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the default owner is already elastic:

elastic-agent-changelog-tool/cmd/root.go

Line 11 in 7c056a9

const defaultOwner = "elastic"

The default repo is beats, we may want to update it to elastic-agent.

```
* Where:
* `x.y.z` is the version to release.
* `owner` is the user / organization the repository to use belongs to.
* `repo` is the name of the repository containing the issues / PRs, etc.
* This will create `./changelog.yaml`. Store it in the repository as `changelog/x.y.x.yaml`.
andresrc marked this conversation as resolved.
Show resolved Hide resolved
* From the root of the repository run:
```
$ elastic-agent-changelog-tool cleanup
```
* Commit the previous changes (consolidated changelod and removed files)
* From the root folder of the repository run:
```
$ elastic-agent-changelog-tool render --version x.y.z
```
* This will generate an asciidoc fragment in __TODO__.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at #62 the output will be generated in the folder specified by the rendered_changelog_destination setting. What is the default value for this setting?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default value is the current folder (.):

elastic-agent-changelog-tool/internal/settings/settings.go

Line 63 in 7c056a9

viper.SetDefault("rendered_changelog_destination", ".")

* Integrate the generated fragment into the changelog. If the changelog is stored in the same repository, commit the changes in this same branch.
* Create a PR with the changes above the `x.y` branch.


### On Release Day

Once the release is given the final go on release day:
* Merge the PR created in the previous section.
* Forward-port it to the other active branches, up to `main`.