Matador GUI

Kildekoden til biblioteket der giver let adgang til at vise og manipulere en brugergrænseflade til spillet Matador i Java. Biblioteket benyttes til CDIO-projekterne på 1. semester.

Guide til GUI

Guiden til brugen af GUI'en findes i et seperat repository her: github.com/diplomit-dtu/MatadorGUIGuide.

Projektstrukturen

Biblioteket udgives som et offentligt Maven dependency, der gør det let for de studerende at hente det ind i deres eget projekt.

Når man bygger og deployer en ny version uploades den til det offentlige Maven-repository der er dedikeret til dette bibliotek. Repostoriet er branchen repository i dette GitHub-repository.

Vil man benytte biblioteket, skal man derfor forbinde til dette Maven-repository, udover at inkludere det som en dependency (se guiden).

Udgiv ny version

Når der er lavet ændringer i biblioteket, skal det offentligøres som en ny version på følgende måde:

1. Hent projektet ned til IntelliJ
   Sørg for at projektet ses som et Maven-projekt af IntelliJ

2. Lav dine ændringer i kildekoden

3. Notér ændringer for ny version i CHANGELOG.md

4. Sørg for at Maven-projektet er opdateret
   Højre klik på pom.xml og tryk på Maven → Reload project

5. Opdatér versionsnummeret i pom.xml
   Følg versioneringskonventionen beskrevet i Versionspolitik

6. Opret en Personal access token til GitHub For at Maven kan pushe til til repoet, skal bruge nogle credentials til din GitHub profil. I stedet for at password skal der benyttes en token.

   • Gå ind under github.com/settings/tokens/

   • Tryk på Generate new token

   • Angiv note så du kan genkende den i fremtiden

   • Kryds følgende scopes af for tokenen:

     • repo
     • notifications
     • user

   • Tryk på Generate Token

   • Kopiér den lange tekst i den grønne boks (kunne se ud som 3f403ba70cad9613242d1d5582cf2vb5bbea2es87). Dette er din token vi skal bruge.
     Bemærk: Du kan ikke fremskaffe den igen, hvis du smider den væk. I så fald opretter du bare en ny, og sletter den gamle.

7. Angiv GitHub credentials til Maven
   Du skal angive sit brugernavn og din nye token til Maven, for at den kan offentliggøre den nye version til repoet

   • Åben din setting.xml-fil til Maven
     Dette gør du ved at højreklikke på pom.xml og tryk på Maven → Open 'settings.xml'

   • Indsæt dine GitHub Credentials
     Kopíer følgende ind i settings.xml, og erstart GITHUB-USERNAME og GITHUB-PASSWORD med dit GitHub brugernavn/password:

      <settings>
         <servers>
            <server>
               <id>github</id>
               <username>DIT_GITHUB_BRUGERNAVN</username>
               <password>DIN_ACCESS_TOKEN</password>
            </server>
         </servers>
      </settings>

     !! ADVARSEL:
     Din token til GitHub vil ligge i clear text i denne fil. Har man denne token kan den bruges til at tilgå nogle rettigheder i i dine repositories, så det anbefales at fjerne din token efter du har deployet

8. Byg og deploy projektet

   • Åben Maven-vinduet i IntelliJ
     I toolbaren trykkes View → Tool Windows → Maven, og i vinduet der åbnes gå ind under matadorgui → Lifecycle

   • Byg og deploy projektet
     Markér alle felterne under Lifecycle og tryk på den grønne pil i vinduet.

     Projektet bygges og offentliggøres til det dedikerede Maven-repository for biblioteket, sammen med kildekoden og JavaDoc.

9. Opdatér GUI-guiden
   Guiden til GUI'en skal opdateres seperat. Hvis ikke den nye version, behøver ændringer i guiden, kan man blot lave en ny branch ud fra den nuværende version.

Versionspolitik

Bibliotekets versionsnummer er beskrevet med 3 niveaue3: major.minor.patch. Hvor hvert niveau betyder følgende:

• major
  Der er laves markante ændringer, der ikke behøver at være kompatible med tidligere versioner. Deprecated metoder kan fjernes.

• minor
  Små nye features. Metoder kan deprecates, men må ikke fjernes og skal stadig fungere.

• patch
  Små bug fixes, og dokumentation af kode, der ikke bringer nye features til brugeren.