Prepare for 1st release #2
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcdumais-work
force-pushed
the
prepare-for-1st-release
branch
3 times, most recently
from
efce3c1
to
1f3a4ad
Compare
This was referenced Jan 19, 2024
marcdumais-work
force-pushed
the
prepare-for-1st-release
branch
from
1f3a4ad
to
dea8775
Compare
Signed-off-by: Marc Dumais <[email protected]>
marcdumais-work
force-pushed
the
prepare-for-1st-release
branch
4 times, most recently
from
0ec388f
to
99ec37c
Compare
The new workflow uses a "RELEASE" file to create, when required, new release tags and GitHub releases. It uses the following GutHub action: https://github.com/pipe-cd/actions-gh-release --- With this in place, the release strategy would be to: - publish to npm locally. As part of publishing, the package's version will be stepped in package.json. Create a commit for that change and also add/update the RELEASE file (*) with corresponding tag. - push that commit for review to the GitHub project - The GitHub action will add a preview of the Github release to be created upon merging - once merged, the new tag and automatically-generated GitHub release will be created, that correspond to the published npm pacakge (*) https://github.com/pipe-cd/actions-gh-release#usage Signed-off-by: Marc Dumais <[email protected]>
Signed-off-by: Marc Dumais <[email protected]>
Signed-off-by: Marc Dumais <[email protected]>
marcdumais-work
force-pushed
the
prepare-for-1st-release
branch
from
99ec37c
to
5510d26
Compare
Signed-off-by: Marc Dumais <[email protected]>
Signed-off-by: Marc Dumais <[email protected]>
|
Sorry for the long delay. I have only lame excuses for not noticing this. This sounds like a plan. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Massage a few things in preparation for a first release to npm.
This PR includes a new GitHub workflow that will be used to create GitHub releases (tag + automatically generated release notes), to go along with what we eventually push to npm. I have outlined the flow in the commit message. This effectively automates half of the work - automating the publishing to npm will be left for later. For now I will publish to npm from my laptop.
Note: CI job "Create or prepare GitHub release" failing is normal at this time, because file ./RELEASE does not yet exist on master. Adding it in this PR will fix this for the future.
Once this PR here is merged, I will tell yarn to step the package's version - this will create a new "release" commit. I will amend that commit to add the new tag in file "RELEASE" and will publish from that commit to npm, and then push that commit as a PR. Once that one is merged, the GitHub release should be automatically created to correspond to the published package.
Sounds like a plan?
P.S. here's an example of a GitHub release created in the same way:
The workflow, the PR with updated tag in RELEASE file and the corresponding automatically created release