-
Notifications
You must be signed in to change notification settings - Fork 0
Setup
Alex B edited this page Jan 12, 2023
·
29 revisions
- Create a new empty GitHub repository with no content
- Clone this repository locally into a new (temporary) folder
- Change the origin of the cloned repo so that points to the newly created empty GitHub repo (this might be helpful)
- The newly created GitHub repo should now contain the contents of this template, you can remove the temporary fodler now
- Replace
vaadin-addon-template
with the repository name - Replace the placeholder images
- Check the Readme
Some settings may require a public repository
- Disable wikis (they are not used by us because the lack versioning and accessibility)
- Disable discussions (issues are sufficient)
- Enable "Automatically delete head branches" (so that there are no "dead"-PR branches)
- Enable "Limit how many branches and tags can be updated in a single push"
- Add the
XDEV Vaadin Addons
-Team with roleMaintain
- Default branch:
develop
- Enable branch protection for
-
develop
(Development-Branch) -
master
("Current Release"-Branch) -
gh-pages
(Online Hosted Documentation)
-
- Source:
Deploy from a branch
- Branch:
gh-pages
Folder:/
(root)
These need to be added by an organization administrator
- Required for releasing to Maven Central
MAVEN_CENTRAL_TOKEN
MAVEN_CENTRAL_USERNAME
MAVEN_GPG_PASSPHRASE
MAVEN_GPG_PRIVATE_KEY
- Required for SonarCloud integration
SONAR_TOKEN
- Required for updates from the template
UPDATE_FROM_TEMPLATE_PAT
- Install SonarCloud (required for SonarCloud integration)
- Log into Vaadin Directory with our company account
- Create a new Component (a initial release might be required so you get a zip that can be uploaded)
- Description
- Component Icon: Our company logo
- Summary: Name of the component
- Description: Description of the component - should look like this:
<Short component description in one sentence> [More infos are available on GitHub](https://github.com/xdev-software/vaadin-chip-combobox) ⚠️ Currently no Maven downloads via Vaadin Directory are possible due to [#31](https://github.com/xdev-software/vaadin-chip-combobox/issues/31)<br> Please use [Maven Central](https://mvnrepository.com/artifact/com.xdev-software/<TODO>) directly. If you found a bug, want to suggest an improvement or have a question please open an issue at GitHub.
- Add matching categories
- Samples
- Add some screenshots how the component looks like (you might reuse the images in
assets
)
- Add some screenshots how the component looks like (you might reuse the images in
- Links
- Add a link to the GitHub repo
- Add a link to the GitHub issue tracker
- Add a link to our company homepage
- All other predefined links can be removed
- Version (initial version)
- Point the release notes to the GitHub Release, e.g.
https://github.com/xdev-software/vaadin-chip-combobox/releases/tag/v3.0.1
- Specify the supported framework, e.g.
Upwards from Vaadin platform 23+
- Maturity: Normally
stable
- Browser compatibility:
- Normally all
Chromium
andFirefox
browser platform independent desktop variants (should be tested before!)- Firefox
- Opera (based Chromium)
- Google Chrome
- Microsoft Edge (based on Chromium)
- Additional:
- If you tested it for mobile platforms you can also check the right side (ignore Windows Phone it's no longer supported)
- Internet Explorer is only available for Windows, no longer supported and can be ignored
- Safari behaves like Internet Explorer for Apple devices and can also be ignored
- Normally all
- Point the release notes to the GitHub Release, e.g.
Important: Do not forget to click onto "Save" (small green button on the top right)
Change the Repository Details/About
- Add a description
- Add a link (website) to the component on Vaadin Directory
- Add some Topics/Labels, e.g.
vaadin
,vaadin-addon
, ... - Disable
Packages
(since we deploy directly to Maven Central)