diff --git a/README.md b/README.md index 7d7c8e52c..b68946eed 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,7 @@ Our mission * [Core Team](patterns/2-structured/core-team.md) - *Even when an InnerSource project is widely needed, contributions and usage may be hindered because the project is difficult to work with. Establish a core team that is dedicated to take care of the project's fundamental items. Their work enables contributors to add and use the features that provide value to their scenarios.* * [Document your Guiding Principles](patterns/2-structured/document-your-guiding-principles.md) - *The usual InnerSource explanation of "applying open source best practices inside an organisation" does not work well with people lacking an open source background. As a remedy the most important principles of InnerSource get documented and published widely.* * [Extensions for Sustainable Growth](/patterns/2-structured/extensions-for-sustainable-growth.md) - *An InnerSource project is receiving too many contributions, making maintenance difficult. By offering an extension mechanism outside of the core project, the maintainers enable scaling of project capabilities with minimal cost and maintenance overhead.* +* [Standard Release Process](patterns/2-structured/release-process.md) - *Teams may hesitate to adopt an InnerSource project if they are unsure of its maturity. To address this, consistent release notes and published artifacts are crucial. These practices showcase a strong dedication to the project, instilling confidence and assuring users of ongoing commitment to sustainable and well-managed software.* * [Group Support](patterns/2-structured/group-support.md) - *What happens if a team or individual no longer supports an InnerSource project? Keep the project alive by forming a group of interested individuals.* ### Maturity Level 1: Initial diff --git a/pattern-categorization/innersource-program-mind-map.md b/pattern-categorization/innersource-program-mind-map.md index 559167619..9bccd8332 100644 --- a/pattern-categorization/innersource-program-mind-map.md +++ b/pattern-categorization/innersource-program-mind-map.md @@ -38,6 +38,12 @@ ##### [Cross-Team Project Valuation](https://patterns.innersourcecommons.org/p/crossteam-project-valuation) +#### Can we rely on the project for an extended period? + +##### [Standard Release Process](https://patterns.innersourcecommons.org/p/release-process) + +##### [Standard Base Documentation](https://patterns.innersourcecommons.org/p/base-documentation) + ### Cultural Challenges #### Unrecognized effort diff --git a/patterns/1-initial/release-process.md b/patterns/1-initial/release-process.md deleted file mode 100644 index e98a02f8a..000000000 --- a/patterns/1-initial/release-process.md +++ /dev/null @@ -1,51 +0,0 @@ -## Title - -Standard Release Process and Published Artifacts - -## Patlet - -Teams may be reluctant to use InnerSource projects that they are unfamiliar with when there is no clear release process apparent in the repository. -Providing clear release notes and a published artifact (binary, docker image, jar, etc) gives people confidence you are publishing a quality product. - -## Problem - -When a team is deciding whether or not to use an InnerSource projects, one of their considerations is whether they trust that they can rely on the given project for an extended period. Switching the tools/projects that they are using has a cost, so they only want to make those investments sporadically. - -It reduces trust if the given InnerSource projects doesn't have a published artifact or publicly viewable release process, as the team won't know when they can expect new features or the next release, how breaking changes are handled, etc. - -## Context - -It is common practice in Open Source projects to have releases, with release notes documenting breaking changes, -new features, etc along with either a published binary or link to a Docker image. This practice may not be as -transparent or well documented/visible for InnerSource projects, modules, etc. Providing robust release notes -along with a published artifact that is the result of a clearly documented and visible release process builds trust and confidence in your project. - -## Forces - -- Difficult for organizations that don't have a central CI/CD system -- Adds the burden of publishing release notes -- Becomes more difficult if the organization does not provide an internal location to host artifacts - -## Solution - -- CI/Delivery Pipeline is located within your repo to build artifacts (binary, docker image, jar, etc) -- Releases and accompanying build artifacts are generated by CI system at build time -- Release includes notes on New Features, Bug Fixes, and any "Breaking Changes" specifically called out - -A good example of quality Release notes can be found [here](https://github.com/jaegertracing/jaeger/releases) - -## Resulting Context - -Teams who come across your project will see published release notes and gain confidence in your tool. Published artifacts also make using your product easier and quicker to adopt. Having well-defined and visible processes such as these also help with cross-team collaboration and new contributors. Folks can be confident that their contributions are made available and distributed in a reasonable amount of time with a clear usage path. - -## Known Instances - -Comcast - -## Authors - -David Grizzanti - -## Status - -**Initial** - FYI we are considering splitting "Published Artifacts" into its own pattern diff --git a/patterns/2-structured/release-process.md b/patterns/2-structured/release-process.md new file mode 100644 index 000000000..0c09a017f --- /dev/null +++ b/patterns/2-structured/release-process.md @@ -0,0 +1,68 @@ +## Title + +Standard Release Process + +## Patlet + +Teams may hesitate to adopt an InnerSource project if they are unsure of its maturity. To address this, consistent release notes and published artifacts are crucial. These practices showcase a strong dedication to the project, instilling confidence and assuring users of ongoing commitment to sustainable and well-managed software. + +## Problem + +When a team is deciding whether to use an InnerSource project, one of their considerations is whether they can rely on the given project for an extended period. Switching the tools/projects that they are using has a cost, so they only want to make those investments when necessary and has tangible benefits. + +It is common practice for Open Source projects to have versioned releases, with notes documenting breaking changes, and new features along with either a published binary or link to a Docker image. This practice may not be as transparent or well documented/visible for InnerSource projects, modules, etc. + +InnerSource projects that don't have a published artifact or release process reduces trust. Teams won't know when they can expect the next release, when breaking changes are introduced, etc. + +## Context + +Large organizations produce a lot of internal software, much of which could be reused by teams across the company. Operational tooling, software libraries, and infrastructure as code (IaC) modules are common examples of this type of software. Most large organizations, however, don't publish internal software to be consumed by other teams in the company. This can occur either because they are to busy to provide documentation or don't realize the projects value to others. + +An internal or public source repository should be available where source code is stored, but teams lack a process for making software consumable by outside teams. + +As an organization grows and more internal software is written, the value of this pattern grows. + +## Forces + +### Difficult for organizations that don't have a central CI/CD system + +For organizations that don't provide engineers a centralized CI/CD system, automating a build and release process can be challenging. The team may need to stand up their own tool (Jenkins, Drone, etc). Without a CI/CD system, builds and release notes can still be produced, however, it may require a local build of the software and manual upload to whichever tool is hosting build artifacts. + +### Added burden of publishing release notes + +In addition to building your source code, writing release notes can be tedious without the ability to auto-generate a list of git commits. This would be left for someone to do manually, in addition to writing more high level details on a release. + +### Increased difficulty without a location to host artifacts + +If a company does not provide a centralized location for storing build artifacts (jars, npm modules, etc.) and docker images, engineers may be left deciding for themselves where is appropriate to store versioned software. Tools like GitHub provide this for you, however, if a company is not using one of these popular tools, this could pose a burden. + +## Solution + +By providing clear **release notes** and a published artifact you increase people's confidence that you are publishing a quality product that they can rely on. + +The following are key elements to achieve this: + +- A CI/CD pipeline is located within your repository that [automates the release process](https://opensource.guide/best-practices/#use-tools-to-automate-basic-maintenance-tasks) +- Build artifacts are generated by the CI/CD system (binary, docker image, jar, etc) +- Releases are clearly labeled and tagged with [semantic versioning](https://github.com/semantic-release/semantic-release) +- Releases include notes on New Features, Bug Fixes, and any "Breaking Changes" + +A good example of quality release notes can be found [here](https://github.com/jaegertracing/jaeger/releases). + +## Resulting Context + +Teams who come across your project will see published release notes and gain confidence in your tool. Published artifacts also make using your product easier and quicker to adopt. Having well-defined and visible processes such as these also help with cross-team collaboration and new contributors. Folks can be confident that their contributions are made available and distributed in a reasonable amount of time with a clear usage path. + +Release notes are also a great opportunity to [praise participants](praise-participants.md)! As we know, [documentation is extremely important](project-setup/base-documentation.md) for new folks looking to get involved with your project. Praising outside teammates for contributions, including documentation and release notes, is a great way to foster community and grow your user base. + +## Known Instances + +* Comcast (multiple projects) + +## Authors + +David Grizzanti + +## Status + +Structured