Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Creative Commons (CC) Open Source Scripts

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

Status

  • Add Community PRs to Project
  • Sync Community Teams with GitHub
  • Track new issues in backlog
  • Normalize Repos
  • Push data to CC Open Source

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 conduct@creativecommons.org per our reporting guidelines.

Contributing

See CONTRIBUTING.md.

Workflows

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

Add Community PRs to Project

Workflow
Schedule: Hourly at 5 minutes past the hour (**:05)
YAML: add_community_pr.yml
Action
subhamX/github-project-bot
Env
Required: ADMIN_GITHUB_TOKEN

This workflow adds community PRs in the creativecommons/vocabulary repository to Vocabulary Planning project.

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.

Track new issues in backlog

Workflow
Schedule: Hourly at 45 minutes past the hour (**:45)
YAML: track_backlog.yml
Action
dhruvkb/issue-projector
Env
Required: ADMIN_GITHUB_TOKEN

This adds PRs to Active Sprint: Code Review and new issues to Backlog: Pending Review.

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:

The destination data is used by the following pages:

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: opensource@creativecommons.org
    message: "Deploy site"
    add: "./example-directory"

License

About

Scripts used to maintain various pieces of CC's open source presence.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages