actions/marocchino-sticky-pull-request-comment
3
0
Fork 0
mirror of https://github.com/marocchino/sticky-pull-request-comment.git synced 2026-04-14 10:06:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: actual logic

Browse source
This commit is contained in:
marocchino 2019-11-21 09:49:05 +09:00
parent 29d48cbb29
commit cb9470fc12
No known key found for this signature in database
GPG key ID: AFF521DBDB122570
9 changed files with 108 additions and 147 deletions
Download patch file Download diff file Expand all files Collapse all files

74
README.md
View file

@ -1,28 +1,23 @@
# Create a JavaScript Action using TypeScript
# Sticky Pull Request Comment
Use this template to bootstrap the creation of a JavaScript action.:rocket:
Create comment on pull request, if exists update that comment.
This template includes compilication support, tests, a validation workflow, publishing, and versioning guidance.
## Development
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
Install the dependencies
## Create an action from this template
Click the `Use this Template` and provide the new repo details for your action
## Code in Master
Install the dependencies
```bash
$ npm install
```
Build the typescript
```bash
$ npm run build
```
Run the tests :heavy_check_mark:
Run the tests :heavy_check_mark:
```bash
$ npm test
@ -34,41 +29,12 @@ $ npm test
...
```
## Change action.yml
The action.yml contains defines the inputs and output for your action.
Update the action.yml with your name, description, inputs and outputs for your action.
See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
## Change the Code
Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
```javascript
import * as core from '@actions/core';
...
async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}
run()
```
See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
## Publish to a distribution branch
Actions are run from GitHub repos. We will create a releases branch and only checkin production modules (core in this case).
Actions are run from GitHub repos. We will create a releases branch and only checkin production modules (core in this case).
Comment out node_modules in .gitignore and create a releases/v1 branch
```bash
# comment out in distribution branches
# node_modules/
@ -86,28 +52,16 @@ $ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```
Your action is now published! :rocket:
Your action is now published! :rocket:
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
## Validate
You can now validate the action by referencing the releases/v1 branch
```yaml
uses: actions/typescript-action@releases/v1
with:
milliseconds: 1000
```
See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
## Usage:
After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and tested action
```yaml
uses: actions/typescript-action@v1
uses: marocchino/sticky-pull-request-comment@v1
with:
milliseconds: 1000
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
message: |
Release ${{ github.sha }} to <https://pr-${{ github.event.number }}.example.com>
```