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

Add release workflow #82

Merged
merged 1 commit into from Dec 16, 2021
Merged

Add release workflow #82

merged 1 commit into from Dec 16, 2021

Conversation

AlicanC
Copy link
Contributor

@AlicanC AlicanC commented Dec 15, 2021

This PR adds a release workflow that publishes packages on push to master.

Resovles #38

@AlicanC AlicanC self-assigned this Dec 15, 2021
Copy link
Member

@rfuelsh rfuelsh left a comment

Choose a reason for hiding this comment

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

@adlerjohn - looks great! great work!

Copy link
Contributor

@adlerjohn adlerjohn left a comment

Choose a reason for hiding this comment

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

Waaaait a second. Do we want to publish to NPM every push to master, or every tagged release?

@rfuelsh
Copy link
Member

rfuelsh commented Dec 16, 2021

I suggest publish npm packages with every push to master (with master being stable code) - my perspective

@adlerjohn
Copy link
Contributor

What would be the version number/string that it would be published under, if it's not for tagged releases?

@rfuelsh
Copy link
Member

rfuelsh commented Dec 16, 2021

@adlerjohn - as you mentioned, publishing npm packages every release is a smart move, but would be good to publish those for master as well perhaps for release v1.2.0 (just an example) something like for master branch "1.2.0-beta" for a package and then for final release "1.2.0" (these names could change of course)

again this it totally up to the dev team - whatever they prefer.

@AlicanC
Copy link
Contributor Author

AlicanC commented Dec 16, 2021

Here's what I had planned:

We have two release channels:

  • Master releases: These are versioned 0.0.0-COMMIT_HASH and NPM tagged (not Git tagged, NPM tagged) as master. npm install foo installs from the latest NPM tag so these 0.0.0-x versions will never be installed unless explicitly specified (like npm install foo@0.0.0-x). They are semver valid, do not interfere with anything and helps us w/ testing.

  • Regular releases: These will be our regular 0.0.1+ versions, published to the NPM tag latest. They shouldn't be transparent like master releases, meaning they should have a Git commit/tag and auto-generated changelogs from commits and they should appear on GH packages and etc. etc.

This PR sets up the "master releases" part and leaves regular releases for later. They are more complicated and I think there should be an effort involving all of our repos for that so we don't reinvent the wheel on every repo.

@AlicanC
Copy link
Contributor Author

AlicanC commented Dec 16, 2021

I've created this issue as a follow-up: #85

@adlerjohn
Copy link
Contributor

Not going to block this PR, but can you document your above comment in the CI config file as a comment @AlicanC?

@AlicanC AlicanC merged commit ffaf915 into master Dec 16, 2021
@AlicanC AlicanC deleted the publishing branch December 16, 2021 14:24
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.

None yet

4 participants