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

[feature] Precursor steps before getting to automated UI tests #2

Open
19 tasks
kopelli opened this issue Aug 3, 2018 · 0 comments
Open
19 tasks

[feature] Precursor steps before getting to automated UI tests #2

kopelli opened this issue Aug 3, 2018 · 0 comments
Labels
enhancement New feature or request

Comments

@kopelli
Copy link
Contributor

kopelli commented Aug 3, 2018

An end goal of being able to write automated UI tests to prevent introducing bugs during refactoring requires a few steps in fixing up how the game artifacts are generated/stored currently. Trying to run the Webpack server currently doesn't work very well because the dynamic files it generates and serves from it's hidden location already exist, so it serves up the existing files instead. Thus we need to fix the release process to have the game artifacts hosted elsewhere.

  • Webpack can produce all artifacts to run the game, including HTML, CSS, and Javascript
    • Webpack needs to take in an HTML template file
    • Webpack will inject the links for all scripts generated into the HTML file
    • Webpack will inject the links for all the stylesheets generated into the HTML file
  • An NPM script that can copy the release build artifacts (and /docs) to a separate Git branch, which started out orphaned.
    • The script should default to the next minor release (e.g. v0.#.0) based on Git tags, but let the person enter a new value if they want
    • The script will pre-populate an editor with the non-merge commits since the last tagged release. This will give a starting point for writing up the change log notes.
    • The script will default to a specific orphaned Git branch (e.g. gh-pages)
    • The script will update 'CONSTANTS' (or the in-game spot that will hold those notes) with the version/release notes
    • The script will add to the Changelog file in /docs
    • The script will commit the changes
    • The script will tag the commit as the source version (e.g. v0.#.0(src))
    • The script will run Webpack to produce the artifacts
    • The script will copy the artifacts & /docs to the orphaned Git branch and commit.
    • The script will tag the commit as the release version.
    • The script will open the URL to post the update to Reddit. Something like https://www.reddit.com/r/Bitburner/submit?selftext=true&title=...v0.#.0...&text=...changelog...
  • Update the Github Pages to point to the orphaned branch rather than master
  • Update ReadTheDocs to point to the orphaned branch rather than master
  • Delete the compiled artifacts from the source branches & add to .gitignore
@kopelli kopelli added the enhancement New feature or request label Aug 3, 2018
@kopelli kopelli self-assigned this Aug 3, 2018
danielyxie pushed a commit that referenced this issue Aug 6, 2018
@kopelli kopelli removed their assignment Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant