Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Sharing and Publishing
This article will cover all the different steps to follow after you've built your web component and are ready to publish and share it. You'll want to complete all the steps below so others know to start using it and contributing to it, since this is the best part about shared web components!
To help application manage which versions of which components they consume, we version our components using semantic versioning. To summarize, if the version is 1.8.5 in the form MAJOR.MINOR.PATCH:
- The MAJOR version number will increase when we make incompatible API changes
- The MINOR version will increase when we introduce backwards-compatible features
- The PATCH version will increase when we make backwards-compatible bug fixes
To release a new version of your web component, all you need to do is create a GitHub release (which uses GitHub tags) against your desired target branch. The target branch will almost always be the
master branch, unless you are maintaining multiple Polymer versions, patching previous versions, etc. After making this release, that version will automatically be available from Bower immediately.
To see some examples, you can check out the releases section of other web components (such as icons).
In addition to being a great place to ask what web components exist today, the #web-platform channel on Slack is where you'll want to call out the existence of your new shared component!
This has multiple benefits:
- People in the channel will know to use your component next time they are looking for that design/functionality, and can work to replace any non-shared versions they may have in their apps
- People in the channel will become advocates for your component the next time someone else joins and asks what web components exist for them to use!
Blogging about it
In addition to the slack call-out in
#web-platform, a blog post on Raining Bytes can be a great way to reach a wider audience with a resource that is easy to find again when needed.
For a great example, you can check out Margaree's blog post that she published after an overhaul to the
button web component and its usage all throughout the monolith.
Anyone can contribute to this blog by updating the GitHub repo.