Merge pull request #459 from GoSecure/rename-master-to-main

Renamed master branch to main (fixes #450)
GoSecure · Dec 13, 2023 · 77d07bb · 77d07bb
2 parents 326ec0d + 4e5703c
commit 77d07bb
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 10 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,7 +6,7 @@ on:
       - '**'
   push:
     branches:
-      - master
+      - main
 
 jobs:
   docker-build:

diff --git a/.github/workflows/dockerhub.yml b/.github/workflows/dockerhub.yml
@@ -4,7 +4,7 @@ name: Publish Docker images
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
     tags:
       - 'v*'
 
@@ -24,9 +24,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v5
         with:
           images: gosecure/pyrdp
+          tags: |
+            # set devel tag for default branch
+            type=raw,value=devel,enable={{is_default_branch}}
       
       - name: Build and push regular Docker image
         uses: docker/build-push-action@v2
@@ -57,9 +60,12 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@v3
+        uses: docker/metadata-action@v5
         with:
           images: gosecure/pyrdp
+          tags: |
+            # set devel tag for default branch
+            type=raw,value=devel,enable={{is_default_branch}}
           flavor: |
             suffix=-slim,onlatest=true
 

diff --git a/.github/workflows/wheels.yml b/.github/workflows/wheels.yml
@@ -6,7 +6,7 @@ on:
       - '**'
   push:
     branches:
-      - master
+      - main
 
 
 jobs:

diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -13,6 +13,7 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 
 * All tools lost their `.py` suffix. For example, `pyrdp-mitm.py` is now `pyrdp-mitm`.
 * Requires Python 3.7
+* master Docker container tag renamed devel (master-slim to devel-slim)
 
 === Enhancements
 
@@ -41,6 +42,7 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * Using cibuildwheel for cross-platform and cross-python builds Windows, Linux, macOS ({uri-issue}451[#451])
 * Deprecation cleanup in CI ({uri-issue}452[#452])
 * Updated our dependencies to the latest stable versions ({uri-issue}454[#454])
+* Renamed master branch to main
 
 
 == v1.2.0 - 2022-12-23

diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
 # PyRDP
 
-![pipeline status](https://github.com/GoSecure/pyrdp/workflows/Build/badge.svg?branch=master)
+![pipeline status](https://github.com/GoSecure/pyrdp/workflows/Build/badge.svg?branch=main)
 [![Black Hat Arsenal 2019](https://raw.githubusercontent.com/toolswatch/badges/master/arsenal/usa/2019.svg?sanitize=true)](https://www.blackhat.com/us-19/arsenal/schedule/index.html)
 [![Black Hat Arsenal 2021](https://raw.githubusercontent.com/toolswatch/badges/master/arsenal/usa/2021.svg?sanitize=true)](https://www.blackhat.com/us-21/arsenal/schedule/index.html)
 [![Black Hat Arsenal 2022](https://raw.githubusercontent.com/toolswatch/badges/master/arsenal/usa/2022.svg?sanitize=true)](https://www.blackhat.com/us-22/arsenal/schedule/index.html#pyrdp-remote-desktop-protocol-mitm-for-purple-teamers-28021)
 
 PyRDP is a Python Remote Desktop Protocol (RDP) Monster-in-the-Middle (MITM) tool and library.
 
-![PyRDP Logo](https://raw.githubusercontent.com/GoSecure/pyrdp/master/docs/pyrdp-logo.svg?sanitize=true)
+![PyRDP Logo](https://raw.githubusercontent.com/GoSecure/pyrdp/main/docs/pyrdp-logo.svg?sanitize=true)
 
 It features a few tools:
 - RDP Monster-in-the-Middle
@@ -83,7 +83,7 @@ docker pull gosecure/pyrdp:latest-slim
 ```
 
 You can find the list of all our Docker images [on the gosecure/pyrdp DockerHub page](https://hub.docker.com/r/gosecure/pyrdp/tags).
-The `latest` tag refers to the latest released version while the `master` tag is the docker image built out of our `master` branch.
+The `latest` tag refers to the latest released version while the `devel` tag is the docker image built out of our `main` branch.
 
 ### From Git Source
 
@@ -306,7 +306,7 @@ There are three different strategies that can be used:
 ###### Monster-in-the-Middle NLA
 If we have access to the server's certificate and private key, we can successfully MITM RDP even if NLA is enforced.
 We [documented this attack in our 1.0 release blog post](https://www.gosecure.net/blog/2020/10/20/announcing-pyrdp-1-0/).
-Instructions to [extract the RDP certificate and private key](https://github.com/GoSecure/pyrdp/blob/master/docs/cert-extraction.md) are available on our GitHub.
+Instructions to [extract the RDP certificate and private key](https://github.com/GoSecure/pyrdp/blob/main/docs/cert-extraction.md) are available on our GitHub.
 
 With the certificate and private key accessible, you just need to set the authentication to `ssp` by adding this on the `pyrdp-mitm.py` command-line:
 ```

diff --git a/docs/devel.adoc b/docs/devel.adoc
@@ -11,7 +11,7 @@ For docker images we rely on `requirements.txt` and `requirements-slim.txt` with
 It is important to keep both approaches in sync and to peridiocally update the requirements files (like before releases).
 See https://github.com/GoSecure/pyrdp/pull/219[the PR where we improved our use of the docker cache] for the reasoning behind this approach.
 
-In a clean tree, on master:
+In a clean tree, on main:
 
 * install and load the venv
 * do a `pip freeze > requirements.txt`
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,7 @@ on: @@
           - '**'
       push:
         branches:
-          - master
+          - main
     jobs:
       docker-build:
@@ Expand Down @@