GitXplorerGitXplorer
R

revanced-static-api

public
7 stars
3 forks
0 issues

Commits

List of commits on branch main.
Verified
64bc4d95ef7207d48a42056dc18f37c89ac794ac

ci: Install Poetry by simplifying steps

ooSumAtrIX committed a year ago
Verified
005bbbd2a912e39f2d957750375d22c93195e83b

chore: Merge branch `dev` to `main`

ooSumAtrIX committed a year ago
Verified
85d60eef0e8b03861ffe5f8203831855254cf9c3

chore: Remove unnecessary project files

ooSumAtrIX committed a year ago
Verified
915db07c72939c10c2c7de92507a7a612070a26c

feat: Commit static files to variable branch

ooSumAtrIX committed a year ago
Verified
c0c91db2dfc701757fccd0eacbc63731ab20fec5

feat: Update example config with real life example

ooSumAtrIX committed a year ago
Verified
31812656233da4af63f9f0bb2bada2bbf5107d9f

fix: Use correct generator namein example config

ooSumAtrIX committed a year ago

README

The README file for this repository.

Static API

Repository to host a static API using GitHub workflows.

How it works

When CI is ran, static files are generated and commited to the specified branch.
The file generator.py provides a list of static file generator classes. Each class has a name.
The configuration file config.json is read which contains the configuration for the API.
By specifying the name of the generator in the generators array of the configuration, the corresponding generator will be used. The current object of the configuration is passed to the generator.

The following configuration generates static files using the contributors and releases generator for selected repositories:

{
  "api": [
    {
      "generators": ["releases", "contributors"],
      "repositories": ["user/repo"]
    }
  ]
}

All static files are generated in the output path specified in the configuration.
The purge array in the configuration specifies which files should be deleted before generating the static files.

Setup

A repository variable CONFIG is expected by CD with the configuration (string escaped) which will be used by CD to generate the static files.