https://github.com/aphistic/screeps-deployer

A GitHub action for deploying to the game Screeps
https://github.com/aphistic/screeps-deployer

Last synced: 3 months ago
JSON representation

A GitHub action for deploying to the game Screeps

• Host: GitHub
• URL: https://github.com/aphistic/screeps-deployer
• Owner: aphistic
• License: mit
• Created: 2019-04-10T01:01:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T00:11:32.000Z (almost 2 years ago)
• Last Synced: 2024-06-20T11:53:08.589Z (7 months ago)
• Language: Go
• Homepage:
• Size: 18.6 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Screeps Deployer

Deploy code to [Screeps](https://screeps.com) from GitHub actions.

__Note:__ Screeps deployer is currently under active development! I use it for my own deployments

but if you do use it at this point be sure to have backups of your code available just in case!

## Usage

### Upload Manifest

Screeps Deployer looks for a file named `screeps.yml` in the root of your repository to determine

how to upload your code to Screeps. Currently the only thing in the file is a list of modules as

well as the files to upload for those modules.

An example file can be seen below:

```yaml

modules:

  - name: main

    file: main.js

  - name: some.name

    file: some/name.js

```

Binary modules are also supported:

```yaml

modules:

  - name: main

    file: main.js

  - name: app

    file: app.wasm

    binary: true

```

### Action Configuration

The deployer uses a [Screeps auth token](https://docs.screeps.com/auth-tokens.html) to perform actions

against the Screeps API.  To provide this token to the action it's recommended to create a secret in

your deployment repository called `SCREEPS_TOKEN` with a full access auth token.  Next, add the action

to your workflow:

```

action "Deploy to Screeps" {

  uses = "aphistic/screeps-deployer@master"

  secrets = ["SCREEPS_TOKEN"]

}

```

When added to a "push" workflow, Screeps deployer will then upload your code to a branch with the same

name as the one pushed to the repository. For example, if you push to the branch `dev` in your GitHub

repository your code will be uploaded to the `dev` branch in Screeps. The `master` branch is currently

set to upload to the `default` branch in Screeps.