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: Document commit-all flag with example #127

Merged
merged 2 commits into from
Oct 11, 2016

Conversation

JaKXz
Copy link
Contributor

@JaKXz JaKXz commented Oct 7, 2016

Resolves #96.

@Tapppi @bcoe please take a look :)

@coveralls
Copy link

coveralls commented Oct 7, 2016

Coverage Status

Coverage remained the same at 100.0% when pulling 32a55eb on JaKXz:docs/commit-all into 476ab9a on conventional-changelog:master.

Copy link
Member

@bcoe bcoe left a comment

Choose a reason for hiding this comment

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

Looks good to me, up to you whether you implement my suggestion 👍


If you want to commit generated artifacts in the release commit (e.g. [#96](https://github.com/conventional-changelog/standard-version/issues/96)), you can use the `--commit-all` or `-a` flag. You will need to stage the artifacts you want to commit, so your `release` command could look like this:

```json
Copy link
Member

Choose a reason for hiding this comment

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

might be good to provide an example of a command that might produce the artifacts, .e.g.,

prerelease: "webpack -p --bail"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think the link to the issue should suffice :) unless there's more support for it I'll leave it as is.

Copy link
Member

Choose a reason for hiding this comment

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

I'm with @bcoe I would add the prerelease script for context. Otherwise this looks good. IMHO it's better to give that one more line of context when people are not that likely to follow a link to a lengthy conversation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will do! :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

One question though, should I leave the link to the issue in?

Copy link
Member

Choose a reason for hiding this comment

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

Sure, I don't think there's any real reason not to. We can remove it if someone deems it "unstylish" 😄 . Thanks!

Copy link
Member

@Tapppi Tapppi left a comment

Choose a reason for hiding this comment

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

I would prefer the changes @bcoe suggested, sorry to review this so late. Busy with work.


If you want to commit generated artifacts in the release commit (e.g. [#96](https://github.com/conventional-changelog/standard-version/issues/96)), you can use the `--commit-all` or `-a` flag. You will need to stage the artifacts you want to commit, so your `release` command could look like this:

```json
Copy link
Member

Choose a reason for hiding this comment

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

I'm with @bcoe I would add the prerelease script for context. Otherwise this looks good. IMHO it's better to give that one more line of context when people are not that likely to follow a link to a lengthy conversation.

@JaKXz
Copy link
Contributor Author

JaKXz commented Oct 11, 2016

@Tapppi ready to go!

@coveralls
Copy link

coveralls commented Oct 11, 2016

Coverage Status

Coverage remained the same at 100.0% when pulling 8758d22 on JaKXz:docs/commit-all into 476ab9a on conventional-changelog:master.

@Tapppi
Copy link
Member

Tapppi commented Oct 11, 2016

Merging this as @bcoe already approved it too.

@Tapppi Tapppi merged commit 8e4ec4a into conventional-changelog:master Oct 11, 2016
@JaKXz JaKXz deleted the docs/commit-all branch October 11, 2016 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants