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

feat: add skipCi option #264

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

flaval
Copy link

@flaval flaval commented Mar 24, 2021

This PR add the ability to plugin's user to specify the way he wants to pass the "skip ci" information.
By default, the [skip ci] keyword is passed to the commit message, but this behavior is not always the required one. Worse, it is hard fixed to the default commit message, and the plugin's user have to copy/paste the default commit message omitting this keyword if he doesn't want it.
This option permit to specify message value to keep the default behavior, pushOption value to use the git "push-option" functionnality (a warning is raised in README about git version compliance) or false to simply remove the keyword in default message.

It answsers to a (already closed) issue #171.

Like I said in this issue, I'm not a really good english speaker/writer, so forgive my comment and please review my README updates. 😅

Another thing, it is my very first contribution/PR on github, I hope I correctly follow the process 🙂

Can customize the way the "skip ci" information is passed to git
@flaval
Copy link
Author

flaval commented Apr 14, 2021

Hello, is there someone here ? @pvdlg are you still here ?
Have I a chance for my PR to be reviewed ?
Thanks

@riconnon
Copy link

I'm a big fan of this... hopefully it can be reviewed.

@flaval
Copy link
Author

flaval commented May 29, 2021

Thanks, but I'm starting to lose hope

@rhtenhove
Copy link

@travi is this something that you'd be interested in? It looks like a great way to clean up the release message.

@tommy31
Copy link

tommy31 commented Aug 25, 2022

Big fan of this feature. Any update ?

@gfaugere-safti
Copy link

@travi If you are interested I could probably rework this in a git push --push-option feature, which I think would be more inline with the "generic git" philosophy of this module?

@gfaugere-safti
Copy link

Anyone from @semantic-release interested in helping moving this feature forward?

@genofire
Copy link

genofire commented Dec 21, 2022

Wow, why is this not merged ?

@travi @gr2m @UziTech

@englut
Copy link

englut commented Nov 26, 2024

I don't use a git forge that supports [skip ci] so this feature to support git push option for -o skip-ci would be greatly appreciated.

@englut
Copy link

englut commented Nov 27, 2024

@flaval I've taken the liberty of patching your fork (on my own fork). It supports opening up the push options to pass any option desired. e.g:

{
...
    [
      "semantic-release-git",
      {
        "assets": [
          "CHANGELOG.md"
        ],
        "skipCi": {
          "pushOption": "skip-ci"
        }
      }
    ],
...
}

I also noticed the tests break if your git uses a default branch name besides master, so I fixed those tests as well.
You can find my patch here if you want to include it into this PR 🙏
englut@87c764d

As I'm unsure if this PR will get approved or merged (it's been years since @flaval opened this), I am installing this in my project (after updating some things in the package.json so there's no conflicts) and using the name semantic-release-git in my configs via:

npm install -g [email protected]:englut/semantic-release-git.git

I've tested this on my own project and it works pretty great! Hope this helps anyone who needs it! 🙏

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.

7 participants