Skip to content

Commit

Permalink
Chore: Update README.md prior to project/repository renaming [skip-ci] (
Browse files Browse the repository at this point in the history
#158)

Signed-off-by: Matthew Watkins <[email protected]>
  • Loading branch information
ModeSevenIndustrialSolutions authored Aug 1, 2024
1 parent e86e175 commit 4d0908f
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
# GitHub Actions Reusable Workflows

[![🔐 CodeQL](https://github.com/os-climate/devops-reusable-workflows/actions/workflows/codeql.yaml/badge.svg)](https://github.com/os-climate/devops-reusable-workflows/actions/workflows/codeql.yaml)
<!-- markdownlint-disable-line MD013 -->[![🔐 CodeQL](https://github.com/os-climate/devops-reusable-workflows/actions/workflows/codeql.yaml/badge.svg)](https://github.com/os-climate/devops-reusable-workflows/actions/workflows/codeql.yaml) [![Dependabot Updates](https://github.com/os-climate/devops-reusable-workflows/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/os-climate/devops-reusable-workflows/actions/workflows/dependabot/dependabot-updates) [![PyPI](https://img.shields.io/pypi/v/pdm?logo=python&logoColor=%23cccccc)](https://pypi.org/project/osc-devops-reusable-workflows)

[![Dependabot Updates](https://github.com/os-climate/devops-reusable-workflows/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/os-climate/devops-reusable-workflows/actions/workflows/dependabot/dependabot-updates)
## Part of the OS-Climate Family of Projects

## Repository: devops-reusable-workflows
This project is part of the OS-Climate and FINOS projects.

### osc-devops-reusable-workflows

This repository contains a number of reusable workflows. The purpose of these
is to provide small pieces of reusable functionality which may be helpful to
the OS-Climate community and projects. Right now, the current focus is on
the OS-Climate community and other projects. Right now, the current focus is on
Python and the tooling around Python projects, since that is the language
currently used for the vast majority of hosted repositories.
currently used for the vast majority of our hosted repositories.

The repository contains some sample Python code which is published to the Python
package index repository and is installable with the Python "pip" command. The
dummy sample project ensures Python packages can be built, tested and published
using the supplied GitHub composite actions, reusable workflows, and workflows.

Further documentation will be supplied here shortly.

To use the workflows in this repository, refer online to the general
documentation covering this topic.
In the meantime, GitHub provides some general documentation covering relevant topics:

- <https://docs.github.com/en/actions/using-workflows/reusing-workflows>
- <https://github.blog/2022-02-10-using-reusable-workflows-github-actions/>
Expand Down

0 comments on commit 4d0908f

Please sign in to comment.