Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for InstallScripts #72

Merged
merged 1 commit into from
May 15, 2024
Merged

Add support for InstallScripts #72

merged 1 commit into from
May 15, 2024

Conversation

EdgarMagalhaes
Copy link
Contributor

@EdgarMagalhaes EdgarMagalhaes commented May 15, 2024

Reason

InstallScripts are useful for setting up environment variables, running processes during installation, and cleaning up files upon uninstallation, thereby enhancing the overall user experience.

Changes

InstallScripts can now be optionally configured by setting the depot[id]InstallScriptPath variable.

Example

jobs:
  deployToSteam:
    runs-on: ubuntu-latest
    steps:
      - uses: game-ci/steam-deploy@v3
        with:
          username: ${{ secrets.STEAM_USERNAME }}          
          configVdf: ${{ secrets.STEAM_CONFIG_VDF}}          
          appId: 1234560
          buildDescription: v1.2.3
          rootPath: build
          depot1Path: StandaloneWindows64
          depot1InstallScriptPath: StandaloneWindows64/install_script.vdf
          depot2Path: StandaloneLinux64
          releaseBranch: prerelease

Checklist

  • Read the contribution guide and accept the code of conduct
  • Readme (updated or not needed)
  • Tests (added, updated or not needed)

Copy link
Member

@GabLeRoux GabLeRoux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. Should we update this page as well?
https://game.ci/docs/github/deployment/steam

@EdgarMagalhaes
Copy link
Contributor Author

Sure, I'll create a PR on https://github.com/game-ci/documentation

@EdgarMagalhaes
Copy link
Contributor Author

Documentation PR available at game-ci/documentation#467

@davidmfinol davidmfinol merged commit 0a1f7f0 into game-ci:main May 15, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants