Skip to content

Commit

Permalink
Add markdown linting
Browse files Browse the repository at this point in the history
  • Loading branch information
arnested committed Aug 16, 2024
1 parent b2d39a7 commit 74d2d76
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 10 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: reviewdog/action-actionlint@v1
markdownlint:
name: markdown
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Run markdownlint
uses: DavidAnson/markdownlint-cli2-action@v16
yamllint:
name: Yamllint
runs-on: ubuntu-22.04
Expand Down
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
# action-platformsh-url

Detecting if PlatformSH is building an environment, and returning the URL when it's done deploying.
Detecting if PlatformSH is building an environment, and returning the
URL when it's done deploying.

## Inputs

- `PLATFORMSH_ID`: The ID of your platform project.
- `PLATFORMSH_KEY`: The API token, generated through PlatformSH.
- Login to [console.platform.sh](https://console.platform.sh)
- "My Profile" > "API Tokens" > "Create API token"
- Remember that this is an access token, and **should not be written in plain text.**
- Add it as an encrypted repo secret - [more info at GitHub docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
- Login to [console.platform.sh](https://console.platform.sh)
- "My Profile" > "API Tokens" > "Create API token"
- Remember that this is an access token, and **should not be written
in plain text.**
- Add it as an encrypted repo secret - [more info at GitHub
docs](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
- `ENVIRONMENT_NAME` (optional): The environment, to check for
- By default, this is set to the `pr-xx`, using `pr-${{ github.event.pull_request.number }}`
- You can also set it to check for the current branch, using `${{ github.head_ref || github.ref_name }}`
- By default, this is set to the `pr-xx`, using `pr-${{
github.event.pull_request.number }}`
- You can also set it to check for the current branch, using `${{
github.head_ref || github.ref_name }}`

See the other inputs in [action.yml](action.yml)

## See also

This action is used for another action, for detecting if a platformsh environment has deployed correctly.

https://github.com/rasben/action-platformsh-deploy-status
This action is used for another action, for detecting if a platformsh
environment has deployed correctly.

<https://github.com/rasben/action-platformsh-deploy-status>

0 comments on commit 74d2d76

Please sign in to comment.