Git Product home page Git Product logo

avrae-alias-update-action's Introduction

Automatic Avrae Alias Updating

This action automatically pushed aliases to Avrae that have been pushed to the master branch (with a bit of setup).

Prerequisite

  • Python 3.8.x
  • https://avrae.io Account
  • Basic File Management/Command Line Knowledge

How to Install

For this you will need to do some changes to your repository, as well as acquire Alias ID's for all the aliases that you wish to automatically update.

Important Note, this script will only recognize alias files that end in .alias or .snippet

  1. Clone this repository to your computer, as it has some scripts you will need to run.
  2. Get your Avrae Token. You can do this by going to the Avrae Website and opening up the developer console. Then, go to Storage, Local Storage, and copy the value of the avrae_token.
    • With your Avrae Token, go to your GitHub Repository and click settings. Then, near the bottom-left click Secrets. Click New Secret and call it AVRAETOKEN, and put your token into the value textbox.
  3. Make a new folder in your repository called .github/workflows. In this folder make a document called update_workflow.yml. Paste the contents of the example-workflow.yml file (that exists in this repository) into your update_workflow.yml
  4. In the base of your repository, make a file called alias-ids.json.
    • Before doing this, in your cloned version of the repository, navigate to the scripts folder and open a terminal there. For each collection you would like to auto-update, run python aliases_from_collection.py (id of collection) (You can get the ID of your collection by looking at the URL bar when on the collections page. it will look something like 5xxxxxxxxxxxxxxxxxxxxxxx). Keep the output of this script, as you will need the ID's
    • In your new alias-ids.json file, you will need to create a dictionary of file paths to alias ids. For example:
{
    "aliases/test-alias.alias": "5xxxxxxxxxxxxxxxxxxxxxxx"
}
  1. Add these new files to your git repository and push to the master branch. The workflow should automatically start running.

Contributing

If you find a bug/issue with anything in this repository, open an issue! If you would like to make a change, open a PR

Further Questions

If you have any other questions contact me at the Avrae Discord. My username is Dr Turtle#1771.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.