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

docs(provenance): make the provenance details easier to consume #614

Merged
merged 3 commits into from
May 9, 2023
Merged

docs(provenance): make the provenance details easier to consume #614

merged 3 commits into from
May 9, 2023

Conversation

lirantal
Copy link
Contributor

@lirantal lirantal commented May 8, 2023

What

Extending the npm provenance section to be more helpful and provide complete example.

Why

CI/CD pipeline failed and required digging into the issue log to find out other permissions are also needed to release a GitHub version, etc.

The change

Updates the npm provenance section with copy/paste working example of YAML code that helps developers not fall into missing permission problems when wanting to enable the feature.

README.md Outdated Show resolved Hide resolved
Copy link
Member

@travi travi left a comment

Choose a reason for hiding this comment

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

also, looks like this fails our lint check. would you mind adjusting with a quick npm run lint:fix?

lirantal and others added 2 commits May 9, 2023 09:22
Co-authored-by: Matt Travi <github@travi.org>
@lirantal
Copy link
Contributor Author

lirantal commented May 9, 2023

Should be fixed now.

Copy link
Member

@travi travi left a comment

Choose a reason for hiding this comment

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

thanks again, @lirantal!

@travi travi changed the title chore: Update README.md docs(provenance): make the provenance details easier to consume May 9, 2023
@travi travi merged commit 6575e97 into semantic-release:master May 9, 2023
@github-actions
Copy link

github-actions bot commented Jun 9, 2023

🎉 This PR is included in version 10.0.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants