Skip to content

manage_Pyapp_github.md

Latest commit

 

History

History
47 lines (28 loc) · 5.12 KB

manage_Pyapp_github.md

File metadata and controls

47 lines (28 loc) · 5.12 KB

Manage your MoveApps Apps with GitHub and PyCharm

Create a GitHub repository

Preferably use our template when creating an App. Click on Use this template and then on Create a new repository to copy the template to a new repository within your GitHub account. Specify its name (this can be the name of the App) and provide a short description (the description can be adjusted later). In order for the MoveApps system to access files from your repository it has to be Public, also for traceability and collaboration in the platform this openness is beneficial. Now click on Create repository to generate your new repository. Make sure that you activate to be notified of All Activity in the repository (see Watch or Unwatch at the top right after creating the repository), so that any issues that users might report about the App will reach you.

Alternatively, if you have downloaded the files from our template locally (Code > Download ZIP), you will have to create a new repository in your personal GitHub account. Specify its name (this can be the name of the App) and provide a short description (the description can be adjusted later). In order for our system to access files from your repository it has to be Public, also for traceability and collaboration in the platform this openness is beneficial. You can choose a license here, but this will be required of you also later in the process of submitting the App to MoveApps. Make sure that you activate to be notified of All Activity in the repository (see Watch or Unwatch at the top right after creating the repository), so that any issues that users might report about the App will reach you.

Clone your GitHub repository

To comfortably work on your local system, develop your code and test your App locally emulating (almost) the online MoveApps system, you can clone your GitHub repository.

with PyCharm

Open PyCharm and create a New Project from Version Control: File > Project from Version Control or Get from VCS. Then enter the URL of your GitHub repository (Code > Local > HTTPS in GitHub), or log in to GitHub, GitHub Enterprise, or GitLab and select your local project directory name.

That's it, you can now use PyCharm to develop and test your code locally (follow the steps to create an App) and push and pull updates to your project via Git in the main menu. The commit window indicates files that have changed and can be pushed to your GitHub respository. Note that it is required to commit your changes with a small description of the changes.

with GitHub Desktop

Another way to work on your local system is by using the GitHub Desktop, which is a software programme often used for Version Control with Git and GitHub. It requires the installation of that programme. Once you have opened GitHub Desktop you can clone a GitHub repository under File > Clone repository, where you can select your repositories (once your account is connected) and clone them to local folders. New files will then be highlighted to be pushed and pulled whenever you open GitHub Desktop. Also here commits and descriptions thereof are required, very comfortably in a small window below the list of changed files. Now you can develop and test your App code locally (follow the steps to create an App).

Keep your repositories up to date (Sync with templates)

To ensure that you can test your App emulating the current MoveApps environment, we have put in place a "Template Synchronization GH action". Once a week GitHub checks if there are updates for your App (see in this image which files are checked/ will be ignored), and makes a pull request (PR).

Ensure that the Actions permissions are correctly set. In your GitHub repository go to Settings > Actions > General and make sure that in the section Workflow permissions the options "Read and write permissions" is selected and "Allow GitHub Actions to create and approve pull requests" is ticked. Save your changes.

This feature was introduced in June 2023. If you created your App before this date, you can manually add this functionality:

  1. Ensure that the Actions permissions are correctly set (see above).

  2. Manually add the folder .github from the Template Python App to your fork.

  3. Once these files are added you can manually execute the GH action named Template Synchronization. To do this, in your GitHub repository go to Actions > Template Synchronization > Run workflow > Run workflow

  4. Add the library deprecated to your environment.yml file.