DEVELOPMENT.md

Development Guide for AWS Service Authentication Tool

This document outlines the steps for building, testing, and contributing to the AWS Service Authentication Tool.

---

Prerequisites

Ensure you have the following installed and configured:

• .NET 8 SDK: Download it from the .NET website.
• AWS CLI: Installed and configured. Refer to the AWS CLI Installation Guide and Configuring the AWS CLI.
• Docker: Installed for ECR authentication. Refer to Docker Installation Guide.
• Git: To clone and manage the repository.

---

Setting Up the Project

1. Clone the repository:

   git clone https://github.com/karimz1/AWS-Service-Authentication-Tool.git
   cd AWS-Service-Authentication-Tool

2. Restore dependencies:

   dotnet restore

3. Build the project:

   dotnet build --configuration Release

4. Run the tool locally:

   dotnet run --project ./src/AwsServiceAuthenticator.Cli/AwsServiceAuthenticator.Cli.csproj -- --command nuget --region us-east-1 --logFolderPath ./logs

---

Testing the Project

Run all tests using the following command:

dotnet test

Ensure all tests pass before submitting changes.

---

Releasing the Tool

This repository uses GitHub Actions to automate releases.

Steps to Publish a New Release

1. Update the version in the .csproj file:

   <PropertyGroup>
       <Version>1.0.0</Version>
   </PropertyGroup>

2. Commit your changes:

   git add .
   git commit -m "Release v1.0.0"

3. Tag the release:

   git tag v1.0.0
   git push origin v1.0.0

4. GitHub Actions will automatically:

   • Build the project for all platforms.
   • Create a new GitHub release.
   • Publish the package to NuGet.org.

---

Contributing

I welcome contributions! To get started:

1. Fork the repository.

2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes and commit them:

   git add .
   git commit -m "Add feature: your-feature-name"

4. Push your branch to your fork:

   git push origin feature/your-feature-name

5. Open a pull request on the main repository.

---

Licensing

This project is licensed under the MIT License. For more details, see the LICENSE file.