Warning

Archived because we moved to using https://webhooks.sapphirejs.dev instead

Skyra Resource Webhooks

Webhook scripts to update Skyra Lounge rules

---

About

Each file in ./resources expects a github webhook in the repositories secrets in the format WEBHOOK_FILE_NAME.

Deploying the webhook messages is done manually via workflow dispatch.

The provided tags are the resource names in discord channel format and separated by the , character.
Example: rules, useful-servers

Adding release announcements

1. Add the file into ./resources. The file name must be RELEASE_YYYY_MM_DD, for example, RELEASE_2021_05_04 for the release of May 4th 2021.
2. Follow steps 2-5 from Adding content

Adding content

1. Add the file into ./resources (The file name should be derived from the channel the webhook will post to for added verbosity. The channel foo-bar becomes FOO_BAR.md)
2. Each new paragraph (double newline character) will be posted in a new message. Try to use as few messages as possible (the limit is 2000 characters per message) to avoid rate limiting. You can add a spacer and simulate a new message with _ _
3. Adding images to a file can be done through
   1. Adding a folder with the same name as the markdown file name in ./resources/images.
   2. Adding images in .png format and give them ALL CAPITALS names.
   3. Referencing them in the markdown file with %PNG_IMAGE_FILE_NAME%.
4. Channel names and other escape sequences should have the format %FOO_BAR% and need to be added to the mapping replacePatterns in ./src/index.ts
5. Add a Webhook requirement to ./.github/workflows/deployment.yml. The repository secret should be prefixed with WEBHOOK_ for added verbosity. The entry for our example is FOO_BAR: ${{ secrets.WEBHOOK_FOO_BAR }}

Deployment content

Once a document is done for posting it can be deployed with the GitHub workflow.

1. Go to the GitHub workflow
2. Click "Run workflow"
3. In the input field add the file name of the file to deploy
4. Confirm with "Run workflow"

Testing a RELEASE deployment

Releases in particular often need to be verified in Discord before they get published to the announcement channel. To this end it is possible to replace the RELEASE part of the file name with DRAFT and it will post to the #test channel in Skyra Development Suite as opposed to #announcements in Skyra Lounge

Buy us some doughnuts

Skyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who may still want to donate just to show their appreciation. Thanks you very much in advance!

We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through your method of choice.

Donate With	QR	Address
Patreon		Click Here
PayPal		Click Here
BitCoin		3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco
Ethereum		0xcB5EDB76Bc9E389514F905D9680589004C00190c
Litecoin		MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Skyra Project!