GithubHelp home page GithubHelp logo

Comments (5)

gr2m avatar gr2m commented on June 15, 2024 1

good questions, I should have been more clear. It was a question by someone who wanted to send a pull request to @octokit/rest documentation but didn't understand the commit conventions. If it was clear that these are only relevant to maintainers then the problem would not have occured.

I think I would add a new header ## Maintainers only here:

## Merging the Pull Request & releasing a new version
Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release).
The following commit message conventions determine which version is released:
1. \`fix: ...\` or \`fix(scope name): ...\` prefix in subject: bumps fix version, e.g. \`1.2.3\` → \`1.2.4\`
2. \`feat: ...\` or \`feat(scope name): ...\` prefix in subject: bumps feature version, e.g. \`1.2.3\` → \`1.3.0\`
3. \`BREAKING CHANGE:\` in body: bumps breaking version, e.g. \`1.2.3\` → \`2.0.0\`
Only one version number is bumped at a time, the highest version change trumps the others.
Besides publishing a new version to npm, semantic-release also creates a git tag and release
on GitHub, generates changelogs from the commit messages and puts them into the release notes.
Before the publish it runs the \`npm run build\` script which creates a \`pkg/\` folder with distributions for browsers, node and Typescript definitions. The contents of the \`pkg/\` folder are published to the npm registry.
If the pull request looks good but does not follow the commit conventions, use the <kbd>Squash & merge</kbd> button.

and then make the current heading level 3: ### Merging the Pull Request & releasing a new version. That should be clear enough?

from create-octokit-project.js.

gr2m avatar gr2m commented on June 15, 2024 1

I'd PR it in this case, because this is such a meta repository

from create-octokit-project.js.

oscard0m avatar oscard0m commented on June 15, 2024

What was the issue with this? (any confusion with contributors so it is needed to improve this description?), also, what do you have in mind? Just highlighting a disclaimer for that section saying is for maintainers only?

from create-octokit-project.js.

oscard0m avatar oscard0m commented on June 15, 2024

good questions, I should have been more clear. It was a question by someone who wanted to send a pull request to @octokit/rest documentation but didn't understand the commit conventions. If it was clear that these are only relevant to maintainers then the problem would not have occured.

I think I would add a new header ## Maintainers only here:

## Merging the Pull Request & releasing a new version
Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release).
The following commit message conventions determine which version is released:
1. \`fix: ...\` or \`fix(scope name): ...\` prefix in subject: bumps fix version, e.g. \`1.2.3\` → \`1.2.4\`
2. \`feat: ...\` or \`feat(scope name): ...\` prefix in subject: bumps feature version, e.g. \`1.2.3\` → \`1.3.0\`
3. \`BREAKING CHANGE:\` in body: bumps breaking version, e.g. \`1.2.3\` → \`2.0.0\`
Only one version number is bumped at a time, the highest version change trumps the others.
Besides publishing a new version to npm, semantic-release also creates a git tag and release
on GitHub, generates changelogs from the commit messages and puts them into the release notes.
Before the publish it runs the \`npm run build\` script which creates a \`pkg/\` folder with distributions for browsers, node and Typescript definitions. The contents of the \`pkg/\` folder are published to the npm registry.
If the pull request looks good but does not follow the commit conventions, use the <kbd>Squash & merge</kbd> button.

and then make the current heading level 3: ### Merging the Pull Request & releasing a new version. That should be clear enough?

Yep. I guess this a goodfirstissue, should we leave it? Or just PR it?

from create-octokit-project.js.

github-actions avatar github-actions commented on June 15, 2024

🎉 This issue has been resolved in version 1.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

from create-octokit-project.js.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.