Creative Commons (CC) Open Source Scripts

These are scripts used to maintain various pieces of CC's open source community infrastructure.

Status

• 
• 
• 
• 

Code of conduct

CODE_OF_CONDUCT.md:

The Creative Commons team is committed to fostering a welcoming community. This project and all other Creative Commons open source projects are governed by our Code of Conduct. Please report unacceptable behavior to [email protected] per our reporting guidelines.

Contributing

See CONTRIBUTING.md.

Workflows

The following workflows are ordered by schedule frequency and start time.

Sync Community Teams with GitHub

Workflow
	Schedule:	Hourly at 30 minutes past the hour (**:30)
	YAML:	sync_community_teams.yml
Script
	File:	sync_community_teams.py
	Common Modules:	ccos/
	Specific Modules:	ccos/norm/
Env
	Required:	ADMIN_GITHUB_TOKEN

This creates GitHub teams for the Community teams and updates their membership based on the community_team_members.json Lektor databag.

• The databag is used to:
  • create the Community Team Members — Creative Commons Open Source page
  • configure GitHub team memberships and repository permissions
• The databag is kept up-to-date by Push data to CC Open Source, below

Manage new issues and pull requests in projects

Workflow
	Schedule:	Hourly at 45 minutes past the hour (**:45)
	YAML:	manage_issues.yml
Script
	File:	manage_new_issues_and_pull_requests.py
	Common Modules:	ccos/
Env
	Required:	ADMIN_GITHUB_TOKEN

This manages new issues and pull requests to ensure they are properly tracked in a GitHub project:

• Applications project
• Systems project
• WebDev project

Normalize Repos

Workflow
	Schedule:	Hourly at 45 minutes past the hour (**:45)
	YAML:	normalize_repos.yml
Script
	File:	normalize_repos.py
	Common Modules:	ccos/
	Specific Modules:	ccos/norm/
Action
		gautamkrishnar/keepalive-workflow
Env
	Required:	ADMIN_GITHUB_TOKEN

This ensures that all active repositories in the creativecommons GitHub organization are consistent in the following ways:

• They have all the labels defined in labels.yml present.
• They have standard branch protections set up (with some exceptions).

This will only update color and description of existing labels or create new labels. It will never delete labels.

Push data to CC Open Source

Workflow
	Schedule:	Daily at midnight:15 (00:15)
	YAML:	push_data_to_ccos.yml
Script
	File:	push_data_to_ccos.py
	Common Modules:	ccos/
	Specific Modules:	ccos/data/
Env
	Required:	ADMIN_ASANA_TOKEN
	Required:	ADMIN_GITHUB_TOKEN

This retreives data from Asana, formats it as a lektor databag, and pushes it to CC Open Source website source repository:

• Data Source: Community Team Tracking - Asana (limited access)
• Data Destination:
  • creativecommons/creativecommons.github.io-source
    • databags/community_team_members.json
    • databags/repos.json

The destination data is used by the following pages:

• Community Team Members — Creative Commons Open Source
• Open Source Projects — Creative Commons Open Source

Environment Variables

• ADMIN_ASANA_TOKEN: Asana token with access to the Creative Commons Asana organization
• ADMIN_GITHUB_TOKEN: GitHub token with admin permissions to the creativecommons GitHub organization

🤖 Automation Authorship

Scripts that commit code or automatically reply to pull requests and issues need to be associated with a GitHub user account. Creative Commons maintains a cc-open-source-bot user for this purpose. This is useful for a few reasons:

• It's ethically important that our community members know when they are talking to a bot instead of a human.
• It makes it easy to audit our automations in the future, because all commits and messages will be associated with the single @cc-open-source-bot user account via the GitHub search, api, etc.
• We won't need to update automations when there are changes to staff or volunteers.

Using this bot clearly communicates when a commit, comment, or action was performed by an automation. For example, here is some configuration for a workflow using the Add & Commit GitHub Action:

# ...other settings here
- name: Commit changes
  uses: EndBug/add-and-commit@v4
  with:
    author_name: cc-open-source-bot
    author_email: [email protected]
    message: "Deploy site"
    add: "./example-directory"

Development

Local development and testing is facilitated by helper scripts:

• ./dev/tools.sh: Checks and updates Python formatting
• .dev/test.sh: Uses act and Docker to test workflows
  • nektos/act: Run your GitHub Actions locally 🚀

Python Dependencies

• Asana/python-asana: Official Python client library for the Asana API v1
• carpedm20/emoji: e_moji terminal output for Python
• gitpython-developers/GitPython: GitPython is a python library used to interact with Git repositories.
• graphql-python/gql: A GraphQL client in Python
• PyGithub/PyGithub: Typed interactions with the GitHub API v3
• PyYAML: a full-featured YAML framework for the Python programming language
• Requests: HTTP for Humans™

GitHub GraphQL API

• Using the API to manage Projects - GitHub Docs
• Forming calls with GraphQL - GitHub Docs

License

• LICENSE (Expat/MIT License)

GitHub GraphQL API schema

The GitHub GraphQL API public schema (ccos/schema.docs.graphql) was downloaded from Public schema - GitHub Docs and is not within scope of the Expat/MIT license of this project.