Skip to content

Commit 61f42b8

Browse files
FejZaFejZa
authored
Merge pull request #2 from Dinomite-Studios/development
Initial docs release
2 parents de9b1f1 + 63d9603 commit 61f42b8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+15366
-123
lines changed

‎.github/FUNDING.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: FejZa

‎.gitignore‎

Lines changed: 16 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,20 @@
1-
# Logs
2-
logs
3-
*.log
4-
npm-debug.log*
5-
yarn-debug.log*
6-
yarn-error.log*
7-
lerna-debug.log*
8-
9-
# Diagnostic reports (https://nodejs.org/api/report.html)
10-
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11-
12-
# Runtime data
13-
pids
14-
*.pid
15-
*.seed
16-
*.pid.lock
17-
18-
# Directory for instrumented libs generated by jscoverage/JSCover
19-
lib-cov
20-
21-
# Coverage directory used by tools like istanbul
22-
coverage
23-
*.lcov
24-
25-
# nyc test coverage
26-
.nyc_output
27-
28-
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29-
.grunt
30-
31-
# Bower dependency directory (https://bower.io/)
32-
bower_components
33-
34-
# node-waf configuration
35-
.lock-wscript
36-
37-
# Compiled binary addons (https://nodejs.org/api/addons.html)
38-
build/Release
39-
40-
# Dependency directories
41-
node_modules/
42-
jspm_packages/
43-
44-
# TypeScript v1 declaration files
45-
typings/
46-
47-
# TypeScript cache
48-
*.tsbuildinfo
1+
# Dependencies
2+
/node_modules
493

50-
# Optional npm cache directory
51-
.npm
4+
# Production
5+
/build
526

53-
# Optional eslint cache
54-
.eslintcache
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
5510

56-
# Microbundle cache
57-
.rpt2_cache/
58-
.rts2_cache_cjs/
59-
.rts2_cache_es/
60-
.rts2_cache_umd/
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
6117

62-
# Optional REPL history
63-
.node_repl_history
64-
65-
# Output of 'npm pack'
66-
*.tgz
67-
68-
# Yarn Integrity file
69-
.yarn-integrity
70-
71-
# dotenv environment variables file
72-
.env
73-
.env.test
74-
75-
# parcel-bundler cache (https://parceljs.org/)
76-
.cache
77-
78-
# Next.js build output
79-
.next
80-
81-
# Nuxt.js build / generate output
82-
.nuxt
83-
dist
84-
85-
# Gatsby files
86-
.cache/
87-
# Comment in the public line in if your project uses Gatsby and *not* Next.js
88-
# https://nextjs.org/blog/next-9-1#public-directory-support
89-
# public
90-
91-
# vuepress build output
92-
.vuepress/dist
93-
94-
# Serverless directories
95-
.serverless/
96-
97-
# FuseBox cache
98-
.fusebox/
99-
100-
# DynamoDB Local files
101-
.dynamodb/
102-
103-
# TernJS port file
104-
.tern-port
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎LICENSE‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎README.md‎

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,45 @@
1-
# unity-azure-pipelines-tasks-docs
2-
Documentation page for https://marketplace.visualstudio.com/items?itemName=DinomiteStudios.64e90d50-a9c0-11e8-a356-d3eab7857116
1+
# Unity Tools for Azure DevOps Documentation
2+
3+
[![Documentation](./static/img/page-preview.png)](https://www.unitydevops.com)
4+
5+
This repository contains the documentation website for [Unity Tools for Azure DevOps](https://marketplace.visualstudio.com/items?itemName=DinomiteStudios.64e90d50-a9c0-11e8-a356-d3eab7857116). A collection of tools and tasks for working with Unity based projects. The website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
6+
7+
## Branches
8+
9+
| Branch | Description | Status |
10+
| ----------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| main | The main branch is build and deployed to [www.unitydevops.com](https://www.unitydevops.com) | ![Build Status](https://dev.azure.com/dinomite/Unity%20Tools%20for%20Azure%20DevOps/_apis/build/status/unity-azure-pipelines-tasks-docs?branchName=main) |
12+
| development | This branch contains latest in development features, fixes and changes and is merged to `main` once stable. | ![Build Status](https://dev.azure.com/dinomite/Unity%20Tools%20for%20Azure%20DevOps/_apis/build/status/unity-azure-pipelines-tasks-docs?branchName=development) |
13+
14+
## Contributions
15+
16+
Found and fixed a bug or improvement on something? Contributions are welcome! Please target your pull request
17+
against the `development` branch.
18+
19+
## Development Instructions
20+
21+
### Installation
22+
23+
```console
24+
npm install
25+
```
26+
27+
### Local Development
28+
29+
```console
30+
npm run start
31+
```
32+
33+
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
34+
35+
### Build
36+
37+
```console
38+
npm run build
39+
```
40+
41+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
42+
43+
### Deployment
44+
45+
The website is deployed via CI/CD when a pull request to the `main` branch has been merged.

‎azure-pipelines.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
trigger:
2+
- main
3+
- development
4+
5+
pool:
6+
vmImage: 'ubuntu-latest'
7+
8+
variables:
9+
- group: 'ftp-variables'
10+
11+
steps:
12+
- task: Npm@1
13+
displayName: 'npm install'
14+
inputs:
15+
command: 'install'
16+
17+
- task: Npm@1
18+
displayName: 'npm run build'
19+
inputs:
20+
command: 'custom'
21+
customCommand: 'run build'
22+
23+
- task: CopyFiles@2
24+
displayName: 'Copy files to artifact staging'
25+
condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
26+
inputs:
27+
SourceFolder: '/build'
28+
Contents: '**'
29+
TargetFolder: '$(Build.ArtifactStagingDirectory)'
30+
CleanTargetFolder: true
31+
OverWrite: true
32+
33+
- task: PublishBuildArtifacts@1
34+
displayName: 'Publish artifacts to Azure Pipelines'
35+
condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
36+
inputs:
37+
PathtoPublish: '$(Build.ArtifactStagingDirectory)'
38+
ArtifactName: 'website'
39+
publishLocation: 'Container'
40+
41+
- task: FtpUpload@2
42+
condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
43+
inputs:
44+
credentialsOption: 'inputs'
45+
serverUrl: '$(ftp.server)'
46+
username: '$(ftp.username)'
47+
password: '$(ftp.password)'
48+
rootDirectory: '$(Build.ArtifactStagingDirectory)'
49+
filePatterns: '**'
50+
remoteDirectory: '/unitydevops.com'
51+
clean: true
52+
preservePaths: true
53+
trustSSL: true

‎babel.config.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

‎docs/about.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
id: about
3+
title: About Unity Tools for Azure DevOps
4+
sidebar_label: About
5+
keywords:
6+
- Unity
7+
- Azure
8+
- DevOps
9+
- Pipelines
10+
- GitHub
11+
slug: /
12+
---
13+
14+
:::note
15+
16+
This documentation assumes you have some knowledge of setting up pipelines using Azure DevOps/Pipelines. If you have questions beyond the scope of this documentation check out this [guide](https://docs.microsoft.com/en-us/azure/devops/pipelines/create-first-pipeline?view=azure-devops&tabs=java%2Ctfs-2018-2%2Cbrowser) to get started with your first Azure Pipeline or join our [Discord](https://discord.gg/RpHSpxkEP6) to find help.
17+
18+
:::
19+
20+
## What is it?
21+
22+
It's an extension to [Azure DevOps](https://azure.microsoft.com/en-us/services/devops/) that adds build and release tasks specifially for [Unity](https://unity.com/) projects. That way it enables implementation of continuous integration and deployment pipelines for an improved workflow that saves time and money.
23+
24+
---
25+
26+
## How to install
27+
28+
The extension is published to the Visual Studio Marketplace and can be installed from there:
29+
30+
1. Open the extension [Unity Tools for Azure DevOps](https://marketplace.visualstudio.com/items?itemName=DinomiteStudios.64e90d50-a9c0-11e8-a356-d3eab7857116) in the marketplace and select `Get it free` to start the installation process.
31+
32+
![Extension in Marketplace](../static/img/vs-marketplace-get-extension.png)
33+
34+
2. Select the Azure DevOps organization you want to install the extension to and proceed by selecting `Install`. *(You may also download the extension if you are using Azure DevOps Server).*
35+
36+
![Install to organization](../static/img/vs-marketplace-install.png)
37+
38+
3. The extension is now installed and you are ready to create your first Unity pipeline.
39+
40+
---
41+
42+
## Supported Unity Versions
43+
44+
Unity Tools for Azure DevOps supports building Unity projects starting from `2017.2.0f1` up to the `latest release` of the Unity editor.
45+
46+
---
47+
48+
## Supported Agents
49+
50+
The extension generally supports Microsoft hosted agents as well as custom agents. Some features may not be available when using hosted agents for older Unity versions and platforms that require setting up e.g. specific SDKs on the machine for builds to work. In such cases, we recommend using a custom agent with full control over tools and software installed.
51+
52+
### Supported Platforms for Hosted Agents
53+
54+
- Standalone Windows
55+
- Standalone macOS
56+
- Standalone Linux
57+
- Universal Windows Platform
58+
59+
:::caution
60+
61+
Please note that a Unity Plus / Pro seat with at least one available activation is required to build using hosted agents. This is a requirement by Unity not this extension. The agent will activate the seat on build and release it again once done.
62+
63+
:::
64+
65+
### Supported Platforms for Custom Agents
66+
67+
- All Unity Platforms supported

‎docs/example-standalone-0.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
id: example-standalone-0
3+
title: Standalone Build And Upload
4+
---
5+
6+
This pipeline example will build a Unity application targeting the Standalone platform and then proceed to upload the exported files from the agent to the Azure DevOps storage, so they can be deployed or distributed as needed in subsequent operations, such as a continuous deployment pipeline.
7+
8+
## At a glance
9+
10+
**Target Platform:** Standalone

‎docs/examples.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
id: examples
3+
title: Examples Overview
4+
---
5+
6+
We have prepared a collection of useful pipeline examples / templates you can copy-paste and adjust to your needs. In case you don't find the right example,
7+
don't hesitate to get in touch via [Discord](https://discord.gg/RpHSpxkEP6) and we'll try and help you out.
8+
9+
## Standalone
10+
11+
- [Build Standalone Application for Windows and upload artifact](example-standalone-0.md)

‎docs/features.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
id: features
3+
title: Features Overview
4+
---
5+
6+
Once `Unity Tools for Azure DevOps` has been installed to your organization, you'll have access to a set of
7+
build and release tasks for Unity related operations. The extension provides the following tasks for use in your pipelines:
8+
9+
Please check each tasks documentation page and for examples on how to use them. Also make sure to checkout our [Examples](./examples.md) collection with useful pipeline definitions you can copy-paste and adjust to your needs.
10+
11+
## Build Tasks
12+
13+
- [Unity Build](unity-build-task.md)
14+
- [Unity CMD](unity-cmd-task.md)
15+
16+
## Testing Tasks
17+
18+
- [Unity Test](unity-test-task.md)
19+
20+
## Utility Tasks
21+
22+
- [Unity Activate License](unity-activate-license-task.md)
23+
- [Unity Get Project Version](unity-get-project-version-task.md)

0 commit comments

Comments
 (0)