-
Notifications
You must be signed in to change notification settings - Fork 32
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 publish: Add release workflow/job, publish-latest job #270
Conversation
405996d
to
74ea325
Compare
|
8232bfd
to
74ea325
Compare
74ea325
to
c7e08e5
Compare
Signed-off-by: Marc Dumais <[email protected]>
The new release workflow uses action "pipe-cd/actions-gh-release". This action uses file RELEASE in the root. When that file is modified in a PR, and contains a new release tag, it will trigger a release upon the PR being merged. The action will create a git tag in the repo and the corresponding GitHub release, containing auto-generated release notes, that can be later edited by a committer. The new release will in turn trigger the new "publish-latest" job (ci-cd workflow), which will publish the new version of the package to npm. Signed-off-by: Marc Dumais <[email protected]>
c7e08e5
to
41d838a
Compare
I have tested |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM for creating releases. Thanks for the contribution.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
small change needed
timeline-chart/package.json
Outdated
"ts-jest": "^29.0.0" | ||
}, | ||
"homepage": "https://github.com/theia-ide/timeline-chart", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this webpage is not correct. It should be https://github.com/eclipse-cdt-cloud/timeline-chart, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops - good catch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
41d838a
to
6118b8b
Compare
add release instructions in root README enhance the library's package.json add README for npm package massaged,Fixed linter warnings in documentation.md, README Signed-off-by: Marc Dumais <[email protected]>
6118b8b
to
1f6625a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution!
Thanks for the review! |
The new release workflow uses action "pipe-cd/actions-gh-release". This action uses file RELEASE in the root. When that file is modified in a PR, and contains a new release tag, it will trigger a release upon the PR being merged. The action will create a git tag in the repo and the corresponding GitHub release, containing auto-generated release notes, that can be later edited by a committer.
The new release will in turn trigger the new "publish-latest" job (ci-cd workflow), which will publish the new version of the package to npm.
Also made misc improvements, e.g. in the package.json, README, ...
Note: it's expected that the "GitHub release" job will fail for now.
To test locally using e.g.
verdaccio
:Look at the release procedure added in the root (developer's) README, section "Release/publish". To test using a local registry, it's required to manually create the release tag (GitHub action
pipe-cd/actions-gh-release
does that in the workflow). I purposefully preventedlerna
creating that tag [1] when runningyarn version:<release type>
to avoid creating a conflicting local tag on a commit that will possibly have a different SHA vs what gets merged, when creating the release PR.[1] by telling lerna to use a bogus command to create the tag:
--git-tag-command /usr/bin/true