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

[ci] add infrastructure for automated releases/publish to npm (latest) #1056

Merged
merged 2 commits into from
Mar 18, 2024

Conversation

marcdumais-work
Copy link
Contributor

@marcdumais-work marcdumais-work commented Mar 14, 2024

This PR adds infrastructure to create GitHub releases (including auto-generated release notes) and publish latest npm packages, as part of the CI of this repository. See updated root README for instructions about how to trigger a release.

Note: it's expected that the "GitHub release" job will fail at this point.

@marcdumais-work marcdumais-work force-pushed the ci-publish-infra branch 2 times, most recently from ec4148f to 50a37b8 Compare March 15, 2024 13:27
# - repo:status, repo_deployment, public_repo, read:org
# See here for more details:
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow
token: ${{ secrets.GH_COMMITTER_TOKEN }}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added that secret/token

@@ -0,0 +1,8 @@
tag: v0.0.0
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I created and pushed that tag, on commit 412b849 - Trace viewer prototype application (the second commit in this repo, right after "Initial commit"). This way, the first generated release notes will go back to the start of the repo's history (we can edit them after as needed)

Copy link
Collaborator

Choose a reason for hiding this comment

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

There is already a 0.1.0 release that was manually pushed to npm and a tag in the repo. Shouldn't you base the new release on the 0.1.0 tag instead?

Copy link
Contributor Author

@marcdumais-work marcdumais-work Mar 15, 2024

Choose a reason for hiding this comment

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

We could, but then the auto-generated release notes would start at v0.1.0. The plan is, after the next release, I will take the release notes and move those relevant to v0.1.0 into a manually-created GitHub release (from that tag). I did similar for time-line chart: https://github.com/eclipse-cdt-cloud/timeline-chart/releases

Copy link
Contributor Author

Choose a reason for hiding this comment

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

timeline-chart: original release notes / GH release, that I manually massaged after release:
eclipse-cdt-cloud/timeline-chart#274 (comment)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Right. Forgot about it. Makes sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

BTW, I'm not sure I was totally clear - the discussed tag (v0.0.0) will only affect the starting point for the auto-generated release notes, when we proceed with the first release, in another PR. This PR here will not result in a release, just setting the stage.

Copy link
Collaborator

Choose a reason for hiding this comment

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

thanks for clarifying

@bhufmann
Copy link
Collaborator

Is it still a draft or ready for review?

@marcdumais-work marcdumais-work force-pushed the ci-publish-infra branch 2 times, most recently from 7378429 to c613bb6 Compare March 18, 2024 12:15
@marcdumais-work marcdumais-work changed the title [wip] [ci] add infrastructure for automated releases/publish to npm (latest) [ci] add infrastructure for automated releases/publish to npm (latest) Mar 18, 2024
@marcdumais-work
Copy link
Contributor Author

Is it still a draft or ready for review?

Yes, I think so. I will transition it out of "draft".

@marcdumais-work marcdumais-work marked this pull request as ready for review March 18, 2024 12:18
Signed-off-by: Marc Dumais <marc.dumais@ericsson.com>
Signed-off-by: Marc Dumais <marc.dumais@ericsson.com>
@bhufmann
Copy link
Collaborator

Is it still a draft or ready for review?

Yes, I think so. I will transition it out of "draft".

I'm going to review it. It looks good so far.

Copy link
Collaborator

@bhufmann bhufmann left a comment

Choose a reason for hiding this comment

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

Thanks for this contribution. It will make it easy to produce release.

@marcdumais-work
Copy link
Contributor Author

Thanks for the review!

@marcdumais-work marcdumais-work merged commit 8c79065 into master Mar 18, 2024
6 of 7 checks passed
@marcdumais-work marcdumais-work deleted the ci-publish-infra branch March 18, 2024 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants