3 Commits
v0.0 ... v0.1.0

Author SHA1 Message Date
github-actions[bot]
5a9880757d chore(main): release 0.1.0 (#7) 2023-05-08 01:26:42 +01:00
9d21ba2763 chore(release): rename release-please manifest file 2023-05-08 01:25:23 +01:00
4d6baa6f81 feat(action)!: change default manifest file path
Brings this action more inline with the upstream action, by keeping the
config and manifest filenames identical, and simply moving them into the
".github" directory.

BREAKING CHANGE: Change default manifest path to `.github/.release-please-manifest.json`.
2023-05-08 01:22:13 +01:00
5 changed files with 35 additions and 20 deletions

3
.github/.release-please-manifest.json vendored Normal file
View File

@@ -0,0 +1,3 @@
{
".": "0.1.0"
}

View File

@@ -1,3 +0,0 @@
{
".": "0.0.6"
}

View File

@@ -1,5 +1,16 @@
# Changelog # Changelog
## [0.1.0](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.6...v0.1.0) (2023-05-08)
### ⚠ BREAKING CHANGES
* **action:** Change default manifest path to `.github/.release-please-manifest.json`.
### Features
* **action:** change default manifest file path ([4d6baa6](https://github.com/jimeh/release-please-manifest-action/commit/4d6baa6f81afde8c72681281cc4f6a9f675b8dda))
## [0.0.6](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.5...v0.0.6) (2023-05-08) ## [0.0.6](https://github.com/jimeh/release-please-manifest-action/compare/v0.0.5...v0.0.6) (2023-05-08)

View File

@@ -40,11 +40,15 @@ running [release-please][] in [manifest mode][].
- Optionally supports having release-please authenticate as a GitHub App. - Optionally supports having release-please authenticate as a GitHub App.
- By default places release-please config and manifest files within the - By default places release-please config and manifest files within the
top-level `.github` directory instead of in the repository root: top-level `.github` directory instead of in the repository root:
- `.github/release-please-manifest.json` - `.github/.release-please-manifest.json`
- `.github/release-please-config.json` - `.github/release-please-config.json`
# Examples # Examples
All examples here assume you have places your `release-please-config.json` and
`.release-please-manifest.json` within the `.github` folder in the root of the
repository.
## Basic (Actions Token) ## Basic (Actions Token)
This example will have release-please authenticate using `secrets.GITHUB_TOKEN` This example will have release-please authenticate using `secrets.GITHUB_TOKEN`
@@ -88,7 +92,7 @@ jobs:
with: with:
command: manifest command: manifest
config-file: .github/release-please-config.json config-file: .github/release-please-config.json
manifest-file: .github/release-please-manifest.json manifest-file: .github/.release-please-manifest.json
``` ```
_Note: Outputs are not included in this equivalence example._ _Note: Outputs are not included in this equivalence example._
@@ -137,7 +141,7 @@ jobs:
token: ${{ secrets.RELEASE_PAT_TOKEN }} token: ${{ secrets.RELEASE_PAT_TOKEN }}
command: manifest command: manifest
config-file: .github/release-please-config.json config-file: .github/release-please-config.json
manifest-file: .github/release-please-manifest.json manifest-file: .github/.release-please-manifest.json
``` ```
_Note: Outputs are not included in this equivalence example._ _Note: Outputs are not included in this equivalence example._
@@ -203,7 +207,7 @@ jobs:
token: ${{ steps.github-app-token.outputs.token }} token: ${{ steps.github-app-token.outputs.token }}
command: manifest command: manifest
config-file: .github/release-please-config.json config-file: .github/release-please-config.json
manifest-file: .github/release-please-manifest.json manifest-file: .github/.release-please-manifest.json
``` ```
_Note: Outputs are not included in this equivalence example._ _Note: Outputs are not included in this equivalence example._
@@ -216,18 +220,18 @@ _Note: Outputs are not included in this equivalence example._
## Inputs ## Inputs
| parameter | description | required | default | | parameter | description | required | default |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------------------------------ | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------------------------------- |
| token | GitHub token used to authenticate. | `false` | ${{ github.token }} | | token | GitHub token used to authenticate. | `false` | ${{ github.token }} |
| app-id | ID of the GitHub App to use for authentication. If set, takes precedence over token input. | `false` | | | app-id | ID of the GitHub App to use for authentication. If set, takes precedence over token input. | `false` | |
| private-key | Private key of the GitHub App (can be Base64 encoded). Required when app-id is provided. | `false` | | | private-key | Private key of the GitHub App (can be Base64 encoded). Required when app-id is provided. | `false` | |
| installation-id | ID of the installation for which the app token will be requested. Defaults to the ID of the repository's installation. | `false` | | | installation-id | ID of the installation for which the app token will be requested. Defaults to the ID of the repository's installation. | `false` | |
| permissions | JSON-stringified permissions granted to the app token. Defaults to all the GitHub app permissions, see: https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app | `false` | | | permissions | JSON-stringified permissions granted to the app token. Defaults to all the GitHub app permissions, see: https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app | `false` | |
| github-api-url | Configure github API URL. | `false` | ${{ github.api_url }} | | github-api-url | Configure github API URL. | `false` | ${{ github.api_url }} |
| repository | The full name of the repository to operate on in owner/repo format. Defaults to the current repository. | `false` | ${{ github.repository }} | | repository | The full name of the repository to operate on in owner/repo format. Defaults to the current repository. | `false` | ${{ github.repository }} |
| default-branch | Branch to open pull release PR against. Defaults to the repository's default branch. | `false` | | | default-branch | Branch to open pull release PR against. Defaults to the repository's default branch. | `false` | |
| config-file | Pat to config file within the project. | `false` | .github/release-please-config.json | | config-file | Pat to config file within the project. | `false` | .github/release-please-config.json |
| manifest-file | Path to manifest file within the project. | `false` | .github/release-please-manifest.json | | manifest-file | Path to manifest file within the project. | `false` | .github/.release-please-manifest.json |
<!-- action-docs-inputs --> <!-- action-docs-inputs -->

View File

@@ -52,7 +52,7 @@ inputs:
manifest-file: manifest-file:
description: Path to manifest file within the project. description: Path to manifest file within the project.
required: false required: false
default: ".github/release-please-manifest.json" default: ".github/.release-please-manifest.json"
outputs: outputs:
release_created: release_created: