feat: initial capability for v1.0

README.md

@@ -1,116 +1,25 @@
-# Create a JavaScript Action
+# get-PR-latest-commit v2
 
-<p align="center">
-  <a href="https://github.com/actions/javascript-action/actions"><img alt="javscript-action status" src="https://github.com/actions/javascript-action/workflows/units-test/badge.svg"></a>
-</p>
+The GitHub Action to get the latest commit on pull request. This Action (written in JavaScript) wraps the "List commits on a pull request" API, and extracts the infomation of the latest commit from the response of the API.
+Through this action, you can get the following information:
 
-Use this template to bootstrap the creation of a JavaScript action.:rocket:
+ * The commit message of the latest commit.
+ * The commit SHA of the latest commit.
+ * The path of a JSON file generated to store the context of the latest commit.
+
+## Inputs
+
+| Name          | Required | Description                                              | Default                                   |
+| `repository`  | YES      | The name of the repository which the pull request is in. | `${{ github.repository }}`                |
+| `pull_number` | YES      | The number of the PR                                     | `${{ github.event.pull_request.number }}` |
+| `token`       | -        | Personal Access Token (PAT) used to authenticate         | `${{ github.token }}`                     |
 
-This template includes tests, linting, a validation workflow, publishing, and versioning guidance.
+## Outputs
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+| Name                    | Description                                                                  |
+| `latest_commit_sha`     | The commit SHA of the latest commit.                                         |
+| `latest_commit_message` | The commit message of the latest commit.                                     |
+| `latest_commit_context` | The path of a JSON file generated to store the context of the latest commit. |
 
-## Create an action from this template
 
-Click the `Use this Template` and provide the new repo details for your action
 
-## Code in Main
-
-Install the dependencies
-
-```bash
-npm install
-```
-
-Run the tests :heavy_check_mark:
-
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-...
-```
-
-## Change action.yml
-
-The action.yml 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
-const core = require('@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.
-
-## Package for distribution
-
-GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
-
-Actions are run from GitHub repos.  Packaging the action will create a packaged action in the dist folder.
-
-Run prepare
-
-```bash
-npm run prepare
-```
-
-Since the packaged index.js is run from the dist folder.
-
-```bash
-git add dist
-```
-
-## Create a release branch
-
-Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
-
-Checkin to the v1 release branch
-
-```bash
-git checkout -b v1
-git commit -a -m "v1 release"
-```
-
-```bash
-git push origin v1
-```
-
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
-
-Your action is now published! :rocket:
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Usage
-
-You can now consume the action by referencing the v1 branch
-
-```yaml
-uses: actions/javascript-action@v1
-with:
-  milliseconds: 1000
-```
-
-See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:

action.yml

@@ -1,13 +1,26 @@
-name: 'Wait'
-description: 'Wait a designated number of milliseconds'
+name: 'get-PR-latest-commit'
+description: 'Get the latest commit on a PR'
 inputs:
-  milliseconds:  # id of input
-    description: 'number of milliseconds to wait'
+  repository:
+    description: 'Repo of code in question'
     required: true
-    default: '1000'
+    default: '${{ github.repository }}'
+  pull_number:
+    description: 'PR number'
+    required: true
+    default: '${{ github.event.pull_request.number }} '
+  token:
+    description: 'Personal Access Token'
+    required: false
+    default: '${{ github.token }}'
 outputs:
-  time: # output will be available to future steps
-    description: 'The message to output'
+  latest_commit_sha:
+    description: 'SHA1 of the latest commit'
+  latest_commit_message:
+    description: 'The commit message of the last commit'
+  latest_commit_context:
+    description: 'The path of a JSON file generated to store the context of the latest commit'
+
 runs:
   using: 'node12'
   main: 'dist/index.js'