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.

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

Initial instructions for release #56

Merged
merged 8 commits into from
Aug 29, 2022
Merged

Conversation

andresrc
Copy link
Collaborator

@andresrc andresrc commented Jun 9, 2022

Targeting the 0.2.0. We will need to add the instructions for the rendering step.

@andresrc andresrc requested review from endorama and ph June 9, 2022 17:57
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jun 9, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-08-29T14:10:23.697+0000

  • Duration: 4 min 23 sec

Test stats 🧪

Test Results
Failed 0
Passed 70
Skipped 0
Total 70

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

docs/usage.md Outdated
* From the root folder of the repository run:

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

Choose a reason for hiding this comment

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

This command will need some additional option to specific the repository.

Copy link
Member

Choose a reason for hiding this comment

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

This is being done in #57: a --owner and --repo flags are added to this command for this purpose

Copy link
Member

Choose a reason for hiding this comment

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

This is now available

* 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

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:

const defaultOwner = "elastic"

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

docs/usage.md Outdated
```
$ 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 (.):

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

Copy link

@ph ph left a comment

Choose a reason for hiding this comment

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

for me the changes lftm, I will let @endorama answer the other questions

docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
andresrc and others added 3 commits August 29, 2022 15:52
Co-authored-by: Edoardo Tenani <526307+endorama@users.noreply.github.com>
Co-authored-by: Edoardo Tenani <526307+endorama@users.noreply.github.com>
@andresrc andresrc merged commit 30c2eb0 into elastic:main Aug 29, 2022
@andresrc andresrc deleted the doc-release branch August 29, 2022 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants