Soveltuvuusselvitys projektin automaattisesta luomisesta Spotify Backstagella
Koivumaa, Teemu (2023)
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-202303193842
https://urn.fi/URN:NBN:fi:amk-202303193842
Tiivistelmä
Opinnäytetyöni aiheena oli luoda soveltuvuusselvitys Spotifyn Backstage-alustan Scaffolder-työkalulle. Opinnäytetyössä haluttiin selvittää, miten voidaan automatisoida uusien ohjelmistoprojektien rungon luominen sekä niihin liittyvää manuaalista työtä. Opinnäytetyön toimeksiantajana toimi OP Osuuskunta.
Opinnäytetyössä käydään läpi soveltuvuusselvityksen eri vaiheet, alustan taustatietojen tutkimisesta itse toteutukseen. Opinnäytetyössä tutkitaan Backstagea tarkemmin ja esitellään sen tarjoamia perusominaisuuksia sekä siihen liittyviä laajennuksia. Opinnäytetyön toteutusosuus aloitettiin tutkimalla Backstagen Scaffolder-työkalua, jotta saataisiin käsitys, miten työkalua voitaisiin käyttää asetetun tavoitteen saavuttamiseen.
Soveltuvuusselvityksen tuloksena toteutettiin Software-templaatti. Templaatin avulla loppukäyttäjä voi määritellä repositoryn, jonne esimerkkiprojekti viedään. Templaattiin kehitetyn automaation avulla pystytään tunnistamaan, onko loppukäyttäjän määrittelemä repository olemassa vai ei. Tämän perusteella automatiikka osaa luoda uuden repositoryn, mikäli se on tarpeen. Opinnäytetyön lopputuloksena saatiin siis toteutettua onnistunut soveltuvuusselvitys, joka toimii hyvänä esimerkkinä tulevaisuuden jatkokehitystä varten. The topic of my thesis was to create a proof of concept for the Scaffolder tool in Spotify's Backstage platform. The thesis wanted to find out how to automate the creation of new software project skeletons and the manual work related to them. The thesis was commissioned by OP Osuuskunta.
The thesis goes through the various stages of the proof of concept journey, from examining the background information of the platform to the implementation itself. The thesis examines Backstage in more detail and presents the basic features it offers as well as, related plugins. The implementation part of the thesis started by studying the Backstages’ Scaffolder tool in order to get an idea of how the tool could be used to achieve the goal.
As a result of the proof of concept, a Software template was implemented. With the help of the template, the end user can define the repository where the example project is exported. With the help of automation developed for the template, it is possible to identify whether the repository defined by the end user exists or not. Based on this, the automation can create a new repository if necessary. As a final result of the thesis, a successful proof of concept was carried out, which serves as a good example for further development in the future.
Opinnäytetyössä käydään läpi soveltuvuusselvityksen eri vaiheet, alustan taustatietojen tutkimisesta itse toteutukseen. Opinnäytetyössä tutkitaan Backstagea tarkemmin ja esitellään sen tarjoamia perusominaisuuksia sekä siihen liittyviä laajennuksia. Opinnäytetyön toteutusosuus aloitettiin tutkimalla Backstagen Scaffolder-työkalua, jotta saataisiin käsitys, miten työkalua voitaisiin käyttää asetetun tavoitteen saavuttamiseen.
Soveltuvuusselvityksen tuloksena toteutettiin Software-templaatti. Templaatin avulla loppukäyttäjä voi määritellä repositoryn, jonne esimerkkiprojekti viedään. Templaattiin kehitetyn automaation avulla pystytään tunnistamaan, onko loppukäyttäjän määrittelemä repository olemassa vai ei. Tämän perusteella automatiikka osaa luoda uuden repositoryn, mikäli se on tarpeen. Opinnäytetyön lopputuloksena saatiin siis toteutettua onnistunut soveltuvuusselvitys, joka toimii hyvänä esimerkkinä tulevaisuuden jatkokehitystä varten.
The thesis goes through the various stages of the proof of concept journey, from examining the background information of the platform to the implementation itself. The thesis examines Backstage in more detail and presents the basic features it offers as well as, related plugins. The implementation part of the thesis started by studying the Backstages’ Scaffolder tool in order to get an idea of how the tool could be used to achieve the goal.
As a result of the proof of concept, a Software template was implemented. With the help of the template, the end user can define the repository where the example project is exported. With the help of automation developed for the template, it is possible to identify whether the repository defined by the end user exists or not. Based on this, the automation can create a new repository if necessary. As a final result of the thesis, a successful proof of concept was carried out, which serves as a good example for further development in the future.