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

Introduce scripts for common tasks #289

Open
13 tasks
alejandrosame opened this issue Sep 13, 2020 · 0 comments
Open
13 tasks

Introduce scripts for common tasks #289

alejandrosame opened this issue Sep 13, 2020 · 0 comments
Assignees
Labels
setup Related to environment setup Status: In Progress 🌟 This is actively being worked on Type: Refactor 🔨 A complete overhaul of a file, feature, or codebase workflow Related to Github workflows

Comments

@alejandrosame
Copy link
Member

alejandrosame commented Sep 13, 2020

What?

We need to align all files that make similar setup and testing tasks.

Why?

Currently, we make similar tasks in different environments. For example, we have repeated code for setup https://github.com/OpenMined/PyDP/blob/dev/Dockerfile#L36, https://github.com/OpenMined/PyDP/blob/dev/.github/workflows/pypipublish_osx.yml#L18, https://github.com/OpenMined/PyDP/blob/dev/prereqs_linux.sh#L58, etc. This makes updates messy because we have to go and chase different files to align repeated code.

Breakdown

  • Create a folder scripts to hold all utility scripts used across the repository.

  • Update Makefile to make use of scripts.

  • Update github workflows to make use of scripts.

    • build_dev_docs.yml
    • pypipublish_linux.yml
    • pypipublish_osx.yml
    • pypipublish_windows.yml
    • style_check.yml
    • tests.yml
  • Update Dockerfile to make use of scripts

  • Update prereqs_linux.sh to make use of scripts

  • Update prereqs_mac.sh to make use of scripts

  • Update contribution guidelines to point to the existence of the folder and require reusing/creating scripts when appropriate.

Additional Context

Add any other context about the problem here.

@alejandrosame alejandrosame added setup Related to environment setup workflow Related to Github workflows Status: In Progress 🌟 This is actively being worked on Type: Refactor 🔨 A complete overhaul of a file, feature, or codebase labels Sep 13, 2020
@alejandrosame alejandrosame added this to the Repository improvements milestone Sep 13, 2020
@alejandrosame alejandrosame self-assigned this Sep 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
setup Related to environment setup Status: In Progress 🌟 This is actively being worked on Type: Refactor 🔨 A complete overhaul of a file, feature, or codebase workflow Related to Github workflows
Projects
None yet
Development

No branches or pull requests

1 participant