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

build: add release-it to facilitate builds #275

Merged
merged 5 commits into from
Apr 18, 2023
Merged

Conversation

LoneRifle
Copy link
Collaborator

@LoneRifle LoneRifle commented Jan 22, 2023

Problem

Releases are currently manual, tedious and prone to human error. While fully automated releases would be great, creating and maintaining such scaffolding would require planning. A much easier alternative would be to automate as much of the process for the publisher as possible

Closes #274

Solution

Port release scaffolding from passport-saml for consistent publishing across all repos in the node-saml organization

  • npm install --save-dev release-it gren
  • add release-it config and changelog run script from passport-saml

@LoneRifle LoneRifle linked an issue Jan 22, 2023 that may be closed by this pull request
package.json Outdated Show resolved Hide resolved
@cjbarth
Copy link
Contributor

cjbarth commented Jan 22, 2023

Are we going to release this on NPM using the @node-saml organization too, or will we continue with the package as it currently is on NPM? What we did with node-saml and passport-saml is we put up a deprecation notice for the unscoped packages and re-published under an NPM organization. It might make sense to do that here.

Port release scaffolding from passport-saml for consistent publishing
across all repos in the node-saml organization

- `npm install --save-dev release-it @cjbarth/github-release-notes`
- add release-it config and changelog run script from passport-saml
- move to node 8 as baseline support to allow for github-release-notes
@LoneRifle
Copy link
Collaborator Author

@cjbarth It's up to you! We've just made one major release with breaking changes not too long ago, so we may as well rename the package (though we would have to copy over the DT types accordingly), since users will have to test before upgrading anyway.

@djaqua
Copy link
Contributor

djaqua commented Feb 17, 2023

I'm on board with making releases easier. Also, do we have someplace where we can manage release goals or have a discussion about the direction of this project?

@LoneRifle
Copy link
Collaborator Author

@cjbarth @djaqua - I would like to have this PR merged so that we can move ahead with releases. As suggested, I will rename the package to @node-saml/xml-crypto

@cjbarth
Copy link
Contributor

cjbarth commented Apr 18, 2023

@LoneRifle , I made a few changes to this to use the latest package for generating changelogs and then added the first changelog. Have a look and LMK what you think. If you approve, I'll land it.

@LoneRifle
Copy link
Collaborator Author

Can't approve something I raise myself! Go ahead and merge.

@cjbarth cjbarth merged commit 1c1ca44 into master Apr 18, 2023
3 checks passed
@cjbarth cjbarth deleted the build/ci/publish branch June 8, 2023 12:42
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.

Make releases with release-it
3 participants