Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit c68ea10

Browse files
authored
update the readme file and action name (#4)
1 parent bba3510 commit c68ea10

File tree

2 files changed

+54
-4
lines changed

2 files changed

+54
-4
lines changed

‎README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,54 @@ A GitHub action to run DB migrations with Database Lab Engine (DLE)
1111
- Protect logs and artifacts from being revealed
1212

1313
## How to use
14-
Check out the [Database Lab DB migrations checker documentation](https://postgres.ai/docs/db-migration-checker)
14+
To use the action, create a yml file in the `.github/workflows/` directory.
15+
16+
Copy and paste the installation snippet from the [Marketplace page](https://github.com/marketplace/actions/database-lab-migration-checker) into your .yml file.
17+
18+
Check out the [Database Lab DB migrations checker documentation](https://postgres.ai/docs/db-migration-checker) to learn how it works and see available configuration options
19+
20+
For example,
21+
22+
```yaml
23+
on: [ push ]
24+
25+
jobs:
26+
migration_job:
27+
runs-on: ubuntu-latest
28+
name: CI migration
29+
steps:
30+
# Checkout the source code
31+
- name: Checkout
32+
uses: actions/checkout@v2
33+
34+
# Run database migrations with the public action
35+
- name: Check database migrations with DLE
36+
uses: postgres-ai/migration-ci-action@v0.1.1
37+
id: db-migrations
38+
with:
39+
dbname: test
40+
commands: |
41+
sqitch deploy
42+
echo 'Migration has been completed'
43+
download_artifacts: true
44+
observation_interval: "10"
45+
max_lock_duration: "1"
46+
max_duration: "600"
47+
env:
48+
DLMC_CI_ENDPOINT: ${{ secrets.DLMC_CI_ENDPOINT }}
49+
DLMC_VERIFICATION_TOKEN: ${{ secrets.DLMC_VERIFICATION_TOKEN }}
50+
51+
# Download artifacts
52+
- name: Upload artifacts
53+
uses: actions/upload-artifact@v2
54+
with:
55+
name: artifacts
56+
path: artifacts/*
57+
if-no-files-found: ignore
58+
if: always()
59+
60+
# Show migration summary
61+
- name: Get the response status
62+
run: echo "${{ steps.db-migrations.outputs.response }}"
63+
64+
```

‎action.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: 'DB migrations checker with DLE'
2-
description: 'Run DB migrations with the DLE'
1+
name: 'Database Lab migration checker'
2+
description: 'Check database migrations with the Database Lab Engine'
33
inputs:
44
owner:
55
description: 'The owner of the repository to check'
@@ -59,7 +59,7 @@ inputs:
5959

6060
outputs:
6161
response:
62-
description: 'The result of CI checks'
62+
description: 'The result of migration checks'
6363
runs:
6464
using: 'docker'
6565
image: 'Dockerfile'

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /