Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use correct GitHub casing #6701

Merged
merged 13 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/styles/UmbracoDocs/Brands.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ swap:
slack: "'Slack'"
azure: "'Azure'"
gitbook: "'GitBook'"
Gitbook: "'GitBook'"
github: "'GitHub'"
Github: "'GitHub'"
2 changes: 1 addition & 1 deletion .github/workflows/Vale-Linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ jobs:
with:
fail_on_error: true
env:
# Required, set by GitHub actions automatically:
# Required, set by GitHub Actions automatically:
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The correct package will have be installed in your project.

## Configuring Blob storage

The next step is to configure your blob storage. There are multiple approaches for this, but in this document, we're going to do it through `appsettings.json`. For more configuration options, see the [readme](https://github.com/umbraco/Umbraco.StorageProviders#umbracostorageproviders) on the Github repository.
The next step is to configure your blob storage. There are multiple approaches for this, but in this document, we're going to do it through `appsettings.json`. For more configuration options, see the [readme](https://github.com/umbraco/Umbraco.StorageProviders#umbracostorageproviders) on the GitHub repository.

Open up your `appsettings.json` file and add the connection string and container name under `Umbraco:Storage:AzureBlob:Media`. Your Umbraco section of appsettings will look something like this:

Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-cms/extending/packages/creating-a-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ The `Title`, `Description`, `PackageTags` came with the template and we added so
| ------------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Version | 1.0.0 | This is automatically set to 1.0.0 but can be changed as appropriate. |
| Authors | Your name | Here you get to take credit for your awesome work! |
| PackageProjectUrl | https://umbraco.com | This URL will be shown as the package's URL when others install it. It will likely be a Github repository, or similar. |
| PackageProjectUrl | https://umbraco.com | This URL will be shown as the package's URL when others install it. It will likely be a GitHub repository, or similar. |
| PackageLicenseExpression | MIT | The license is set to MIT. Please consider how you want your package licensed. If in doubt when deciding an open-source license there are [good resources available](https://choosealicense.com/licenses/). |

### Pack it
Expand Down
10 changes: 5 additions & 5 deletions 10/umbraco-cms/extending/packages/example-package-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Finally there's an [example Umbraco website](https://github.com/umbraco/Umbraco.

As well as the projects, the following files are added to the solution:

- [.artifactignore](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.artifactignore) - used by AzureDevOps services to [control which files are uploaded when you publish](https://learn.microsoft.com/en-us/azure/devops/artifacts/reference/artifactignore?view=azure-devops). This helps to reduce pipeline execution time.
- [.artifactignore](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.artifactignore) - used by Azure DevOps services to [control which files are uploaded when you publish](https://learn.microsoft.com/en-us/azure/devops/artifacts/reference/artifactignore?view=azure-devops). This helps to reduce pipeline execution time.
- [.editorconfig](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.editorconfig) - used to [enforce consistent coding styles](https://editorconfig.org/) for multiple developers working on the same project across editors and IDEs.
- [.gitignore](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.gitignore) - controls which files are added to source control.
- [.globalconfig](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/.globalconfig) - provides [further styling rules for the project files, even if stored outside of the project directory](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files#global-analyzerconfig).
Expand All @@ -58,7 +58,7 @@ As well as the projects, the following files are added to the solution:

## Build and Deployment

We use AzureDevOps pipelines for continuous integration and releasing new versions of the package. The definition of how the project is built is defined in a `.yaml` file that's part of the source code repository.
We use Azure DevOps pipelines for continuous integration and releasing new versions of the package. The definition of how the project is built is defined in a `.yaml` file that's part of the source code repository.

The file can be found [here](https://github.com/umbraco/Umbraco.AuthorizedServices/blob/main/azure-pipeline%20-%20Umbraco.AuthorizedServices.yml).

Expand All @@ -68,13 +68,13 @@ Even if using another tool it may be worth reviewing how we have setup our pipel

The build consists of two stages: building the solution and running unit tests. Only if both succeed is the build as a whole considered successful.

![AzureDevOps build pipeline](./images/azuredevops-build.png)
![Azure DevOps build pipeline](./images/azuredevops-build.png)

### Releasing the Package

We release the package manually in AzureDevOps, with a two stage process. Firstly we release to a "pre-releases" feed, and then after manual approval, to NuGet.
We release the package manually in Azure DevOps, with a two stage process. Firstly we release to a "pre-releases" feed, and then after manual approval, to NuGet.

![AzureDevOps release pipeline](./images/azuredevops-release.png)
![Azure DevOps release pipeline](./images/azuredevops-release.png)



Expand Down
4 changes: 2 additions & 2 deletions 10/umbraco-cms/extending/ui-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You can also change the stylesheet of custom properties to see how the component

## Installing the UI Library Components

You can download the UI Library package from [Github](https://github.com/umbraco/Umbraco.UI/tree/v1/contrib/packages).
You can download the UI Library package from [GitHub](https://github.com/umbraco/Umbraco.UI/tree/v1/contrib/packages).

If you are installing a component via npm, there are two ways to import it:

Expand All @@ -40,7 +40,7 @@ If you are installing a component via npm, there are two ways to import it:
'@umbraco-ui/uui-button/lib/uui-button.element';
```

For more information on installation, Content Delivery Networks (CDN), or included components, see the [Readme file in the Github](https://github.com/umbraco/Umbraco.UI#readme) project.
For more information on installation, Content Delivery Networks (CDN), or included components, see the [Readme file in the GitHub](https://github.com/umbraco/Umbraco.UI#readme) project.

## Getting Started with the UI Library

Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-cms/reference/security/cookies.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ services.AddSession(options =>
});
```

For information on the rest of the cookies, see the [Constants-Web.cs](https://github.com/umbraco/Umbraco-CMS/blob/v10/contrib/src/Umbraco.Core/Constants-Web.cs) file on Github.
For information on the rest of the cookies, see the [Constants-Web.cs](https://github.com/umbraco/Umbraco-CMS/blob/v10/contrib/src/Umbraco.Core/Constants-Web.cs) file on GitHub.
42 changes: 21 additions & 21 deletions 10/umbraco-cms/tutorials/creating-and-distributing-a-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@
* [Creating a test site locally](creating-and-distributing-a-package.md#creating-a-test-site-locally)
* [Creating a package from the backoffice](creating-and-distributing-a-package.md#creating-a-package-from-the-backoffice)
* [Creating a draft package on Our](creating-and-distributing-a-package.md#creating-a-draft-package-on-our)
* [Pushing your package to Github](creating-and-distributing-a-package.md#pushing-your-package-to-github)
* [Pushing your package to GitHub](creating-and-distributing-a-package.md#pushing-your-package-to-github)
* [Pack up your package locally using UmbPack](creating-and-distributing-a-package.md#pack-up-your-package-locally-using-umbpack)
* [Pushing your package to Our using UmbPack](creating-and-distributing-a-package.md#pushing-your-package-to-our-using-umbpack)
* [Deploy your package using Github Actions](creating-and-distributing-a-package.md#deploy-your-package-using-github-actions)
* [Deploy your package using GitHub Actions](creating-and-distributing-a-package.md#deploy-your-package-using-github-actions)
* [Archive older versions on push](creating-and-distributing-a-package.md#archive-older-versions-on-push)

## Prerequisites

To run this tutorial you will need the following:

* Be able to run an Umbraco site locally
* Git + Github account
* Git + GitHub account
* [Our Umbraco member account](https://our.umbraco.com/member/Signup) with access to upload packages
* UmbPack installed
* Umbraco Package templates installed
Expand Down Expand Up @@ -60,7 +60,7 @@
dotnet new umbraco-v8-package -n PackageWorkshop -d
```

This will create a new package called `PackageWorkshop`, and add a custom Dashboard for us to use in this tutorial. By default you will also get a Github Action added that we will return to later.
This will create a new package called `PackageWorkshop`, and add a custom Dashboard for us to use in this tutorial. By default you will also get a GitHub Action added that we will return to later.

After running you will have a folder called `PackageWorkshop`, inside that you will have your site and solution files. So try to open it in Visual Studio or Rider by opening the `PackageWorkshop.sln` file.

Expand Down Expand Up @@ -234,13 +234,13 @@

The next step is to make it a bit simpler to deploy updates to the package. It is perfectly fine to log in here and upload a new version each time. The next steps will show an easier way though.

## Pushing your package to Github
## Pushing your package to GitHub

If you are creating a package in order to share it with others it is a great idea to also share the source code. It is the open source way.

To share it, and make it easier to manage and deploy updates we will set up a Github repository for the package. This tutorial assumes you know what Github is, and that you have an account.
To share it, and make it easier to manage and deploy updates we will set up a GitHub repository for the package. This tutorial assumes you know what GitHub is, and that you have an account.

Create a fresh repo, with no readme, gitignore or license - do not choose a repository template (set to 'No Template'). On the second screen it will give you a command to push an existing repository to the new Github repo, should look like this but with your own user in the link:
Create a fresh repo, with no readme, gitignore or license - do not choose a repository template (set to 'No Template'). On the second screen it will give you a command to push an existing repository to the new GitHub repo, should look like this but with your own user in the link:

Check warning on line 243 in 10/umbraco-cms/tutorials/creating-and-distributing-a-package.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "10/umbraco-cms/tutorials/creating-and-distributing-a-package.md", "range": {"start": {"line": 243, "column": 121}}}, "severity": "WARNING"}

```none
git remote add origin https://github.com/jmayntzhusen/package-workshop.git
Expand All @@ -257,26 +257,26 @@
git commit -m "Initial commit, dashboard package"
```

At this point you have your solution in a local git repository, and we can then use the command from Github to push it up:
At this point you have your solution in a local git repository, and we can then use the command from GitHub to push it up:

```none
git remote add origin https://github.com/jmayntzhusen/package-workshop.git
git branch -M main
git push -u origin main
```

Now you have it all on Github:
Now you have it all on GitHub:

![Github repo](<images/github-repo (1).png>)
![GitHub repo](<images/github-repo (1).png>)

## Pack up your package locally using UmbPack

At this point you know how to create a package from the backoffice, upload it to Our and push your changes to Github. That's what it takes to create and maintain a package.
At this point you know how to create a package from the backoffice, upload it to Our and push your changes to GitHub. That's what it takes to create and maintain a package.

If you want to make changes and push a new version you can carry out the following steps:

* Create the new package in the backoffice
* Sync your code to Github
* Sync your code to GitHub
* Go to Our and upload a new zip version
* Set that to the current version
* Optionally archive the previous one
Expand Down Expand Up @@ -399,15 +399,15 @@

So at this point we can work on our package locally, build a new version within seconds by running the pack command and then deploy it to Our using the push command.

Not easy enough for you? Let's try automating this entire thing with Github actions then.
Not easy enough for you? Let's try automating this entire thing with GitHub Actions then.

Check warning on line 402 in 10/umbraco-cms/tutorials/creating-and-distributing-a-package.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.Editorializing] Consider removing 'easy' Raw Output: {"message": "[UmbracoDocs.Editorializing] Consider removing 'easy'", "location": {"path": "10/umbraco-cms/tutorials/creating-and-distributing-a-package.md", "range": {"start": {"line": 402, "column": 5}}}, "severity": "WARNING"}

## Deploy your package using Github Actions
## Deploy your package using GitHub Actions

If you think back to the beginning when we set up our sites using the Package Templates you may remember that by default you get a Github action installed as well.
If you think back to the beginning when we set up our sites using the Package Templates you may remember that by default you get a GitHub action installed as well.

Check warning on line 406 in 10/umbraco-cms/tutorials/creating-and-distributing-a-package.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "10/umbraco-cms/tutorials/creating-and-distributing-a-package.md", "range": {"start": {"line": 406, "column": 1}}}, "severity": "WARNING"}

If you check out the `~/.github/workflows` folder in your solution, you will see there is a readme file and a build.yml file.

The build.yml file is used by Github actions, which will perform some tasks for you when certain criteria are met. If you haven't worked with continuous integration and deployment (CI/CD) before, then this may seem like magic - but don't worry we will run through the commands.
The build.yml file is used by GitHub Actions, which will perform some tasks for you when certain criteria are met. If you haven't worked with continuous integration and deployment (CI/CD) before, then this may seem like magic - but don't worry we will run through the commands.

Check warning on line 410 in 10/umbraco-cms/tutorials/creating-and-distributing-a-package.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "10/umbraco-cms/tutorials/creating-and-distributing-a-package.md", "range": {"start": {"line": 410, "column": 116}}}, "severity": "WARNING"}

The build.yml file contains several things, let's have a quick overview:

Expand All @@ -433,9 +433,9 @@
It sets the version of the package to be what we've set in the release tag based on a previous step.
{% endhint %}

Below this there is another step to push the package to Our, which again is like our approach locally - except now we add the API key as a Github secret so it's not public to everyone.
Below this there is another step to push the package to Our, which again is like our approach locally - except now we add the API key as a GitHub secret so it's not public to everyone.

Check warning on line 436 in 10/umbraco-cms/tutorials/creating-and-distributing-a-package.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "10/umbraco-cms/tutorials/creating-and-distributing-a-package.md", "range": {"start": {"line": 436, "column": 1}}}, "severity": "WARNING"}

![Github secret](images/gh-secret.png)
![GitHub secret](images/gh-secret.png)

```yml
- name: Push to Our
Expand All @@ -444,7 +444,7 @@

With these 2 commands and a few previous ones setting up the prerequisite build and nuget tools it is now ready to be fully automated.

Ensure you have set a Github secret with the name `UMBRACO_DEPLOY_KEY` and the value of the key from Our, and then go to your local solution and uncomment the UmbPack push command in the \~/.github/workflows/build.yml file.
Ensure you have set a GitHub secret with the name `UMBRACO_DEPLOY_KEY` and the value of the key from Our, and then go to your local solution and uncomment the UmbPack push command in the \~/.github/workflows/build.yml file.

Check warning on line 447 in 10/umbraco-cms/tutorials/creating-and-distributing-a-package.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "10/umbraco-cms/tutorials/creating-and-distributing-a-package.md", "range": {"start": {"line": 447, "column": 1}}}, "severity": "WARNING"}

Check warning on line 447 in 10/umbraco-cms/tutorials/creating-and-distributing-a-package.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [UmbracoDocs.Brands] We prefer 'GitHub' over 'github.' Raw Output: {"message": "[UmbracoDocs.Brands] We prefer 'GitHub' over 'github.'", "location": {"path": "10/umbraco-cms/tutorials/creating-and-distributing-a-package.md", "range": {"start": {"line": 447, "column": 192}}}, "severity": "WARNING"}

Then make sure it is added and committed locally:

Expand All @@ -454,14 +454,14 @@
git push
```

Your solution and Github repo are now in sync, and the umbpack commands in the Github action are enabled and ready to run. Final step is to create a release tag and push it to Github:
Your solution and GitHub repo are now in sync, and the umbpack commands in the GitHub action are enabled and ready to run. Final step is to create a release tag and push it to GitHub:

```none
git tag release/1.0.0
git push origin release/1.0.0
```

At this point you can go to Github and visit the Action tab to see your Github action run. When it's completed successfully you can go to your package overview on Our and see the package there.
At this point you can go to GitHub and visit the Action tab to see your GitHub action run. When it's completed successfully you can go to your package overview on Our and see the package there.

## Archive older versions on push

Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-commerce/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@ This section contains the release notes for Umbraco Commerce 10 including all ch

## Legacy release notes

You can find the release notes for **Vendr** in the [Change log file on Github](../../13/umbraco-commerce/changelog-archive/Vendr-core.md).
You can find the release notes for **Vendr** in the [Change log file on GitHub](../../13/umbraco-commerce/changelog-archive/Vendr-core.md).
2 changes: 1 addition & 1 deletion 10/umbraco-commerce/upgrading/version-specific-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ See the [Migrate from Vendr to Umbraco Commerce guide](../upgrading/migrate-from

## Legacy version specific upgrade notes

You can find the version specific upgrade notes for versions out of support in the [Legacy documentation on Github](https://github.com/umbraco/UmbracoDocs/tree/umbraco-eol-versions).&#x20;
You can find the version specific upgrade notes for versions out of support in the [Legacy documentation on GitHub](https://github.com/umbraco/UmbracoDocs/tree/umbraco-eol-versions).&#x20;
2 changes: 1 addition & 1 deletion 10/umbraco-deploy/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* [Getting started](getting-started/get-started-with-deploy.md)
* [CI/CD Build and Deployment Pipeline](getting-started/cicd-pipeline/README.md)
* [Azure DevOps](getting-started/cicd-pipeline/ci-cd-azure-dev-ops.md)
* [Github actions](getting-started/cicd-pipeline/ci-cd-github-actions.md)
* [GitHub Actions](getting-started/cicd-pipeline/ci-cd-github-actions.md)
* [Streamlining Local Development](getting-started/streamlining-local-development.md)
* [Configuration](getting-started/deploy-settings.md)

Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-deploy/deployment-workflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Umbraco Deploy uses a two-part deployment approach where we keep meta data (Docu

In summary:

1. Meta data such as Document Types, Templates, Forms, Views and config files are stored in a repository and are **deployed** between environments. This can be achieved using a CI/CD deployment pipeline with something like Github Actions or Azure DevOps.
1. Meta data such as Document Types, Templates, Forms, Views and config files are stored in a repository and are **deployed** between environments. This can be achieved using a CI/CD deployment pipeline with something like GitHub Actions or Azure DevOps.
2. Content and Media items are **not** stored in the repository. These need to be **transferred** directly from the Umbraco backoffice using the _"Queue for Transfer"_ option. Once a content editor has all the items needed for a transfer they will use the Deployment Dashboard in the Content section to transfer the items in the queue.

### Deploying meta data
Expand Down
Loading
Loading