Skip to content

A GitHub Action that automates packaging and uploading Factorio mods to the mod portal.

License

Notifications You must be signed in to change notification settings

TheBrutalX/Factorio-mod-uploader-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Release CodeQL Advanced

Factorio Mod Uploader - GitHub Action

This repository hosts a GitHub Action specifically designed to simplify and automate the workflow for packaging and uploading Factorio mods to the Factorio Mod Portal.

Key Features:

  • Version Control Integration: Checks out the repository to ensure the latest changes are included.
  • Dependency Management: Installs all necessary dependencies for the mod build process.
  • Automated Build: Handles the mod packaging process efficiently.
  • Seamless Deployment: Automatically uploads the packaged mod to the Factorio Mod Portal.

Streamline your mod development process with this action and ensure your updates are delivered faster and with fewer manual steps.

Perfect for Factorio mod developers looking for a robust and hands-free deployment solution.

Workflow Example

Create a workflow file in .github/workflows/publish.yml:

name: Publish Factorio Mod

on:
    push:
        branches:
            - main

jobs:
    publish-mod:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout Repository
              uses: actions/checkout@v4

            - name: Validate Mod
              uses: TheBrutalX/factorio-mod-uploader-action@v2
              with:
                  action: validate

            - name: Create zip
              uses: TheBrutalX/factorio-mod-uploader-action@v2
              with:
                  action: compress

            - name: Upload Mod
              uses: TheBrutalX/factorio-mod-uploader-action@v2
              with:
                  action: upload
                  factorio-api-key: ${{ secrets.FACTORIO_API_KEY }}

This is the basic version, for the specific option see the detail of each step

This is the basic version, for the specific option see the detail of each step

If you need to understand the file I have written a guide in the Wiki

Step overview

See all the details of each step in the Wiki

About

A GitHub Action that automates packaging and uploading Factorio mods to the mod portal.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published