Skip to content

Commit

Permalink
Rename Master to Main in Docs and Code (winery#639)
Browse files Browse the repository at this point in the history
Signed-off-by: Lukas Harzenetter <[email protected]>
  • Loading branch information
lharzenetter authored Dec 16, 2021
1 parent d327761 commit ecb0050
Show file tree
Hide file tree
Showing 19 changed files with 57 additions and 32 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- describe the changes you have made here: what, why, ... -->

- [ ] Ensure that you followed our [toolchain guide](https://github.com/eclipse/winery/blob/master/docs/dev/github-workflow.md#github---prepare-final-pull-request). Especially, we require **a single commit**
- [ ] Ensure that you followed our [toolchain guide](https://github.com/eclipse/winery/blob/main/docs/dev/github-workflow.md#github---prepare-final-pull-request). Especially, we require **a single commit**
- [ ] Ensure that the commit message is [a good commit message](https://github.com/joelparkerhenderson/git_commit_message)
- [ ] Ensure to use auto format in **all** files
- [ ] Ensure that you appear in `NOTICE` at Copyright Holders
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Winery CI
on:
push:
branches:
- master
- main
pull_request:

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/dockerhub.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name: Push docker images to Dockerhub
on:
push:
branches:
- master
- main
tags:
- "v*.*.*"

Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Here, the categories "Changed" for added and changed functionality,
We refer to [GitHub issues](https://github.com/eclipse/winery/issues) by using `#NUM`.

The ordering of v1.x and v2.x versions is sequential by time.
This is similar to [Angular's CHANGELOG.md](https://github.com/angular/angular/blob/master/CHANGELOG.md), where v4.x and v5.x is mixed.
This is similar to [Angular's CHANGELOG.md](https://github.com/angular/angular/blob/main/CHANGELOG.md), where v4.x and v5.x is mixed.

## [unreleased]

Expand Down Expand Up @@ -75,6 +75,6 @@ Intermediate milestone build for the OpenTOSCA eco system.
This was the initial code contribution when handing over project governance to the Eclipse Software Foundation.
See also [CQ 7916](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=7916).

[unreleased]: https://github.com/eclipse/winery/compare/v2.0.0-M1...master
[unreleased]: https://github.com/eclipse/winery/compare/v2.0.0-M1...main
[v2.0.0-M1]: https://github.com/eclipse/winery/compare/initial-code-contribution...v2.0.0-M1
[v1.0.0]: https://github.com/eclipse/winery/compare/initial-code-contribution...v1.0.0
2 changes: 1 addition & 1 deletion deploy/che/devfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ components:
discoverable: "false"
public: "true"
mountSources: true
reference: https://raw.githubusercontent.com/eclipse/winery/master/deploy/che/winery.yaml
reference: https://raw.githubusercontent.com/eclipse/winery/main/deploy/che/winery.yaml
2 changes: 1 addition & 1 deletion docs/dev/branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

# Branches

The `master` branch is always compiling and all tests should go through.
The `main` branch is always compiling and all tests should go through.
It contains the most recent improvements.
All other branches are real development branches and might event not compile.

Expand Down
20 changes: 10 additions & 10 deletions docs/dev/github-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ For the general setup, please go to [Eclipse Winery Toolchain](toolchain.md).
Main idea: Separate branch for each topic (fix a bug, add functionality) and accordingly named.
See <https://guides.github.com/introduction/flow/index.html> for more information.

1. Sync with latest changes on upstream (especially master branch): `git fetch upstream --prune`.
3. Create branch based on `upstream/master` and make it known publicly:
- `git checkout upstream/master`
1. Sync with latest changes on upstream (especially main branch): `git fetch upstream --prune`.
3. Create branch based on `upstream/main` and make it known publicly:
- `git checkout upstream/main`
- `git checkout -b [name]`
Branch naming patterns:
- Bugfix: `fix/SHORT-TITLE`, e.g., `fix/deletion-of-namespaces`
Expand Down Expand Up @@ -67,9 +67,9 @@ After each working day, do the following:

1. Commit. Don't forget to sign the commit (<kbd>Ctrl</kbd>+<kbd>S</kbd> in Git Gui).
2. `git push`
3. Keep your branch updated with `upstream/master`:
3. Keep your branch updated with `upstream/main`:
- `git fetch upstream`
- `git merge upstream/master`
- `git merge upstream/main`
- Resolve conflicts - if there are some. See <https://www.jetbrains.com/help/idea/resolving-conflicts.html> for a documentation when using IntellIJ.
- `git push`

Expand All @@ -89,16 +89,16 @@ This is required by the Eclipse process for checking for intellectual property (
### Git Steps: Ensure that a single commit is created

1. `git fetch upstream` - fetches all updates from https://github.com/eclipse/winery ("upstream") to the local git storage
2. `git merge upstream/master` - merges all updates from upstream to the local branch
2. `git merge upstream/main` - merges all updates from upstream to the local branch
3. (Resolve merge conflicts) - required if there are conflicting changes
4. Commit & Push with signed commit message (<kbd>Ctrl</kbd>+<kbd>S</kbd> in Git Gui) - this ensures that you have the changes backuped in case something goes wrong at the next steps
5. `git reset upstream/master` - this prepares that all commits can be squashed together:
The local checkout ("working tree") is left untouched, but the "pointer" of the current branch is reset to `upstream/master`.
Now, Git Gui shows the difference between `upstream/master` and your changes.
5. `git reset upstream/main` - this prepares that all commits can be squashed together:
The local checkout ("working tree") is left untouched, but the "pointer" of the current branch is reset to `upstream/main`.
Now, Git Gui shows the difference between `upstream/main` and your changes.
6. Check changes in Git Gui:
- Each change you wanted: Is it recognized?
- At each file: Is the copyright information in the [header](source-code-headers.md) OK?
- Check if you are listed in the [NOTICE](https://github.com/eclipse/winery/blob/master/NOTICE) file as a contributor with the correct year
- Check if you are listed in the [NOTICE](https://github.com/eclipse/winery/blob/main/NOTICE) file as a contributor with the correct year
- Are there too much changed lines? 🡒 Do not stage spurious lines to the commit (e.g., tab to spaces, ...)
- Are there too much changed files? 🡒 Do not stage files you did not intend to change (e.g., `build.gradle` if you did not touch `build.gradle` at all)
- Check again the style (!)
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/property-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The frontend is build using the web framework angular2. An Angular2 application

The following will explain the use of the propertiesDefinition component by example of its usage in the policy type instance.

To make the frontend part of the winery application as modular, component based and generic as possible, the following architecture was chosen ([see here](https://github.com/eclipse/winery/blob/master/docs/dev/RepositoryUI.md)).
To make the frontend part of the winery application as modular, component based and generic as possible, the following architecture was chosen ([see here](https://github.com/eclipse/winery/blob/main/docs/dev/RepositoryUI.md)).
The instance component is responsible for rendering most of the types/templates. As a result of that, the components required for a type/template are being injected into the instance components router outlet. This is true for the policy type as well.

Here is one example on how to use the propertiesDefinition component by example of the policy type (instance component).
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ Organizational information is provided at the `eclipse.org page <http://eclipse.
dev/index.md
tosca/index.rst
adr/index.md
How to Contribute <https://github.com/eclipse/winery/blob/master/CONTRIBUTING.md>
Found an issue? <https://github.com/eclipse/winery/blob/master/CONTRIBUTING.md#contributing-issues>
How to Contribute <https://github.com/eclipse/winery/blob/main/CONTRIBUTING.md>
Found an issue? <https://github.com/eclipse/winery/blob/main/CONTRIBUTING.md#contributing-issues>


Getting support for Eclipse Winery
Expand Down
2 changes: 1 addition & 1 deletion docs/user/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ A: If you need support, contact us at *[email protected]*.
Q: How can I contribute to Winery?
**********************************

A: Please see the `contributing guide <https://github.com/eclipse/winery/blob/master/CONTRIBUTING.md>`_.
A: Please see the `contributing guide <https://github.com/eclipse/winery/blob/main/CONTRIBUTING.md>`_.
24 changes: 24 additions & 0 deletions org.eclipse.winery.accountability/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,30 @@

<!-- This plugin compiles the Solidity Ethereum smart contracts and provides Java wrapper classes for them
(that allow communicating with them and deploying them on the blockchain)-->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.0.2</version>
<executions>
<execution>
<id>copy-resource-one</id>
<phase>generate-sources</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${user.home}/.web3j/solc/</outputDirectory>
<resources>
<resource>
<directory>${project.basedir}</directory>
<includes>
<include>releases.json</include>
</includes>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.web3j</groupId>
<artifactId>web3j-maven-plugin</artifactId>
Expand Down
Loading

0 comments on commit ecb0050

Please sign in to comment.