Skip to content

Draft: General Cleanup and full VPM Support. Added CI Pipeline.

BluWizard requested to merge (removed):master into master

I've done some cleaning up and organizing the files to ensure the transition to making Filamented a VPM Repository be a smooth one. There's a lot of things I've done here, so please take a look at the new file organization in full detail when you can.

Here's the list of my changes:

  • Reorganized File Directories to comply with UPM Guidelines. The Scripts in ./Filamented/Editor were moved into ./Editor and the Filamented folder has been sorted into ./Runtime folder. Both Directories have their respective .asmdef files. AltGUI.asmdef was somehow corrupted with no info showing, so I replaced it with a fresh one with similar settings. The Scripts seem to compile, but please feel free to test it.
  • A new file only visible on GitLab is .gitlab-ci.yml. This file is the automation pipeline you can use to create new release builds, triggered by a Tag pushed to the branch. To fully use it, see my instructions below.
  • Updated the package.json to fully support the VPM format, especially as a Community Repository. Version was bumped to v1.2.0.

To fully use the GitLab Pipeline I have created in this Merge Request, follow these instructions:

  1. Create an Access Token in Settings -> Access Tokens
  • Use the name CI_PRIVATE_TOKEN with the Role Reporter.
  • Set Scopes to api and read_repository.
  • Copy the Token value created.
  1. Go to Settings -> CI/CD -> Variables and add a Variable. Set the following properties:
  • Set Environments to All (default).
  • Set Flags to Masked and Expanded. DO NOT USE Protected or else there will be issues.
  • Type in CI_PRIVATE_TOKEN as the Key.
  • Paste in the Token value you created in Step 1 as the Value.

If configured correctly, the Pipeline Build should automatically run whenever you push a Tag to the Repository. If the Run is successful, it will be deployed to Deploy -> Releases with the name "Release ${COMMIT_TAG}".

Copy the sole Link created for the Packages in your Release and use that in your VCC Repository's source.json in the "releases": [] line. Follow the JSON format for more releases you add. Deploy the Repository and now you should be able to successfully use it into your Project in Creator Companion!

Edited by BluWizard

Merge request reports