Skip to content

Conversation

@Chisanan232
Copy link
Owner

Pre-Checking

‼️Please must read this section and check by yourself.
⚠️Do NOT modify this section if it doesn't have any necessary reason.

Please verify the PR header should be satisfied below format:

[commit topic] (commit scope) <commit summary>
  • commit topic: The major topic of your modify. It could have multiple topics, e.g., [Breaking Change + Test].
  • commit scope: The scope in project of modify. It could have multiple scopes, e.g., (config + test).
  • commit summary: Summary of the commits. It should be clear that the target, the KEY POINT why you modify it or what you resolve, etc.

Please refer to GCR (Git Commit Rules) of
GitHub-Action-Template-Python
to get more detail about it.


Target

  • Add sample Python code and configurations of relative tool for testing workflows to ensure that its functions could work finely.
  • Fix some issues in workflows I found in development process.

Modify Code Scope

  • GitHub Action settings all in .github/workflows.
  • requirements directory for sample Python dependencies settings.
  • scripts directory for some sample shell scripts in CI or development.
  • test directory for sample testing code of sample Python library code.
  • test_gh_workflow directory for sample Python library source code.
  • .coveragerc, a configuration for Python tool about calculating testing coverage.
  • .gitignore, just for development.
  • codecov.yml, a configuration of Codecov which is a platform provides developers to record and analyze testing coverage state of project.
  • pytest.ini, a configuration of Python tool PyTest for running testing.

Effecting Scope

  • The all automations after developers pushes their commits to GitHub platform.

Description

  • Sample Python library:

    • Add sample source code and its testing:

      • Sample function to get Hello Python.
      • Testing includes testing code, some configurations related testing like PyTest, coverage, etc.
    • Add configuration about running CI processes:

      • It would need some shell scripts for working in CI automations, it includes setup runtime environment process with requirements and do something automation with scripts.
  • Bugs in GitHub Action workflow template:

    • Bug 1: Incorrect usage at option jobs.<job_id>.uses in workflow configuration

      The value of that option is /.github/workflows/@master, so it always imports the configuration from git branch master so that it cannot work finely with the latest configuration because the latest state must in git branch develop. So modify it to local usage as ./.github/workflows/.

    • Bug 2: Incorrect usage at action actions/download-artifact@v3

      The option path of action actions/download-artifact@v3 means that it would download all the files by the option name to the path by the option path. It does NOT mean that which file(s) would be downloaded.

…flows from git branch 'master' in CI testing process.
…al, it does not need to send git branch info.
Chisanan232 and others added 2 commits August 21, 2022 22:36
🎉🎊🍾 [New Feature] (config) Add sample code and configurations for testing workflows to ensure its functions.
@Chisanan232 Chisanan232 merged commit a0e118a into master Aug 21, 2022
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.

2 participants