diff --git a/README.md b/README.md index 6f4d714..4068398 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -## wiki-deploy +## deploy-action GitHub Action to automate user script and gadget deployments to Wikimedia wikis. ## Usage -* Setup either a [BotPassword](https://en.wikipedia.org/wiki/Special:BotPasswords) or a [owner-only OAuth2 credentials](https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose/oauth2?wpownerOnly=1) for your user account, which will get used for updating the script pages. +* Setup either a [BotPassword](https://en.wikipedia.org/wiki/Special:BotPasswords) or an [owner-only OAuth2 credentials](https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose/oauth2?wpownerOnly=1) for your user account, which will get used for updating the script pages. * Make sure the grant to allow editing your user CSS/JSON/JavaScript is checked. -* [Save the credentials](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to GitHub Secrets in your repo (either the OAUTH2_TOKEN, or the USERNAME and PASSWORD) . +* [Save the credentials](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to GitHub Secrets in your repo (either the OAUTH2_TOKEN, or the USERNAME and PASSWORD). * Add a file `deploy.yml` under `.github/workflows`, with the content: @@ -25,7 +25,7 @@ jobs: # Run build and ensure tests are passing before deployment - run: npm run --if-present build - run: npm run --if-present test - - uses: wikimedia-gadgets/wiki-deploy@v1 + - uses: wikimedia-gadgets/deploy-action@v1 with: paths: 'src/myscript.js User:SD0001/myscript.js' apiUrl: 'https://en.wikipedia.org/w/api.php'