Add commitish to config (#771)

release-drafter · Feb 5, 2021 · 4bd7c3c · 4bd7c3c
1 parent 193a397
commit 4bd7c3c
Show file tree

Hide file tree

Showing 9 changed files with 110 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -113,6 +113,7 @@ You can configure Release Drafter using the following key in your `.github/relea
 | `prerelease`           | Optional | Mark the draft release as pre-release. Default `false`.                                                                                                                    |
 | `version-resolver`     | Optional | Adjust the `$RESOLVED_VERSION` variable using labels. Refer to [Version Resolver](#version-resolver) to learn more about this                                              |
 | `filter-by-commitish`  | Optional | Filter previous releases to consider only the target branch of the release. Default: `false`.                                                                              |
+| `commitish`            | Optional | Specify the target branch of the release. Default: the default branch of the repo.                                                                                         |
 
 Release Drafter also supports [Probot Config](https://github.com/probot/probot-config), if you want to store your configuration files in a central repository. This allows you to share configurations between projects, and create a organization-wide configuration file by creating a repository named `.github` with the file `.github/release-drafter.yml`.
 
@@ -277,6 +278,7 @@ The Release Drafter GitHub Action accepts a number of optional inputs directly i
 | `version`     | The version to be associated with the GitHub release that's created or updated. This will override any version calculated by the release-drafter.                                                                                                                                                                                                                  |
 | `publish`     | A boolean indicating whether the release being created or updated should be immediately published. This may be useful if the output of a previous workflow step determines that a new version of your project has been (or will be) released, as with [`salsify/action-detect-and-tag-new-version`](https://github.com/salsify/action-detect-and-tag-new-version). |
 | `prerelease`  | A boolean indicating whether the relase being created or updated is a prerelease.                                                                                                                                                                                                                                                                                  |
+| `commitish`   | A string specifying the target branch for the release being created.                                                                                                                                                                                                                                                                                               |
 
 ## Action Outputs
 

diff --git a/action.yml b/action.yml
@@ -38,6 +38,11 @@ inputs:
       A boolean indicating whether the relase being created or updated is a prerelease.
     required: false
     default: ''
+  commitish:
+    description: |
+      The object that the release should be created to point to.
+    required: false
+    default: ''
 outputs:
   id:
     description: The ID of therelease that was created or updated.

diff --git a/dist/index.js b/dist/index.js
@@ -410,6 +410,7 @@ const DEFAULT_CONFIG = Object.freeze({
   'sort-direction': SORT_DIRECTIONS.descending,
   prerelease: false,
   'filter-by-commitish': false,
+  commitish: '',
   'category-template': `## $TITLE`,
 })
 
@@ -799,10 +800,13 @@ module.exports.generateReleaseInfo = ({
       : ''
   }
 
+  let commitish = config['commitish'] || ''
+
   return {
     name,
     tag,
     body,
+    commitish,
     prerelease: isPreRelease,
     draft: shouldDraft,
   }
@@ -811,6 +815,7 @@ module.exports.generateReleaseInfo = ({
 module.exports.createRelease = ({ context, releaseInfo }) => {
   return context.octokit.repos.createRelease(
     context.repo({
+      target_commitish: releaseInfo.commitish,
       name: releaseInfo.name,
       tag_name: releaseInfo.tag,
       body: releaseInfo.body,
@@ -919,6 +924,8 @@ const schema = (context) => {
         DEFAULT_CONFIG['filter-by-commitish']
       ),
 
+      commitish: Joi.string().allow('').default(DEFAULT_CONFIG['commitish']),
+
       replacers: Joi.array()
         .items(
           Joi.object().keys({

diff --git a/lib/default-config.js b/lib/default-config.js
@@ -21,6 +21,7 @@ const DEFAULT_CONFIG = Object.freeze({
   'sort-direction': SORT_DIRECTIONS.descending,
   prerelease: false,
   'filter-by-commitish': false,
+  commitish: '',
   'category-template': `## $TITLE`,
 })
 

diff --git a/lib/releases.js b/lib/releases.js
@@ -290,10 +290,13 @@ module.exports.generateReleaseInfo = ({
       : ''
   }
 
+  let commitish = config['commitish'] || ''
+
   return {
     name,
     tag,
     body,
+    commitish,
     prerelease: isPreRelease,
     draft: shouldDraft,
   }
@@ -302,6 +305,7 @@ module.exports.generateReleaseInfo = ({
 module.exports.createRelease = ({ context, releaseInfo }) => {
   return context.octokit.repos.createRelease(
     context.repo({
+      target_commitish: releaseInfo.commitish,
       name: releaseInfo.name,
       tag_name: releaseInfo.tag,
       body: releaseInfo.body,

diff --git a/lib/schema.js b/lib/schema.js
@@ -60,6 +60,8 @@ const schema = (context) => {
         DEFAULT_CONFIG['filter-by-commitish']
       ),
 
+      commitish: Joi.string().allow('').default(DEFAULT_CONFIG['commitish']),
+
       replacers: Joi.array()
         .items(
           Joi.object().keys({

diff --git a/test/fixtures/config/config-with-commitish.yml b/test/fixtures/config/config-with-commitish.yml
@@ -0,0 +1,2 @@
+commitish: 'staging'
+template: 'dummy'