Julkaisukäytäntö ja komponenttien elinkaari
Kela Design Systemin julkaisukäytäntö ja komponenttien elinkaari.
Julkaisukäytäntö
KDS noudattaa semanttista versiointia(Avautuu uuteen välilehteen).
Periaatteita:
- Uudet ominaisuudet julkaistaan vain viimeisimpään major-versioon.
- Edellinen major-versio on tuettuna ylläpitotilassa kuuden kuukauden ajan, uuden major-version julkaisusta. Ylläpitotilassa olevaan versioon tehdään vain kriittiset virhekorjaukset.
- Tiedossa olevat merkittävät virhekorjaukset pyritään saamaan mukaan seuraavaan minor-versioon.
| Versio | Esimerkki | Kuvaus | Julkaisutahti |
|---|---|---|---|
| Suuri (major) | 14.0.0 | Suuret muutokset ja vanhentuneiden ominaisuuksien poistot, jotka saattavat sisältää rikkovia muutoksia. Edellyttävät usein sovelluksiin muutoksia. | Enintään 6 kk välein tai harvemmin |
| Pieni (minor) | 13.6.0 | Pienemmät muutokset, jotka eivät sisällä rikkovia muutoksia, kuten uudet komponentit ja muut uudet ominaisuudet. | Noin kuukauden välein |
| Paikka (patch) | 13.5.1 | Virhekorjaukset tarvittaessa kriittisiin ongelmiin, jos ongelmaan ei ole olemassa tilapäistä korjausta sovelluksen puolella. | Tarvittaessa |
Kaikki muutokset löytyvät versiohistoriasta.
Alpha-versiot
KDS:stä julkaistaan alpha-versio jokaisen muutoksen jälkeen. Alpha-versiot ovat keskeneräisiä ja ominaisuuksiltaan puutteellisia, eikä niiden tuotantokäyttöä suositella. Alpha-versioilla voi kuitenkin kokeilla uusia ominaisuuksia tai poikkeustilanteessa ottaa jonkin muutoksen nopeasti käyttöön.
Käyttöönotto-ohjeesta löydät tiedot alpha-version asentamisesta.
Ominaisuudet, jotka noudattavat julkaisukäytäntöä
| Ominaisuus | Kuvaus |
|---|---|
| React-komponentit | Komponenttien nimet, komponenttien proppien nimet ja arvot tai komponenttien käyttötapa ei muutu. Ulkoasu saattaa muuttua. |
| Design-muuttujat | Design-muuttujien nimet eivät muutu. Arvot saattavat muuttua. |
| CSS-apuluokat | CSS-apuluokkien nimet eivät muutu. Joissain tapauksessa arvo saattaa muuttua (esim. väri). |
| Kuvakkeet, ikonit ja logot | Kuvakkeiden, ikonien ja logojen nimet eivät muutu. Sisältö saattaa muuttua. |
| Teemamuuttujat | Ei dokumentoitu. Teemamuuttujat tulevat dist/css/themes/kela.min.css tai dist/css/themes/kanta.min.css tiedostoista. Sovellusten kannattaa pääasiassa hyödyntää dokumentoituja design-muuttujia, koska teeman vaihtoa ei sovelluksissa tarvita. |
| Tyylitiedostojen nimet | Käyttöönotto-ohjeessa mainitut tyylitiedostojen nimet. |
| Exportoidut TypeScript-tyypitykset | Exportoidut komponenttien proppien tyypit tai nimet eivät muutu rikkovasti, esim. ButtonProps. Private-merkinnällä nimetyt yksittäiset tiedostot tai types-hakemistossa olevat tyypit ovat yksityisiä, eikä niitä kannata hyödyntää, esim. Button.types.private.d.ts. |
| Polut, joista komponentteja tai muita resursseja tuodaan sovelluksiin |
Ominaisuudet, jotka eivät noudata julkaisukäytäntöä
| Ominaisuus | Kuvaus |
|---|---|
| Komponenttien ulkoasu | Komponenttien ulkoasuun tehdään tarvittaessa muutoksia. |
| React-komponenttien CSS-luokat ja HTML-rakenne | KDS:n ensisijainen käyttötapa on React-komponentit, joten niiden sisäisten CSS-luokkien ja HTML-rakenteen muutokset eivät noudata julkaisukäytäntöä. Ylimääräisiä muutoksia pyritään kuitenkin välttämään. |
| Komponenttien sisäiset CSS-muuttujat | Komponenttien sisäisiä muuttujia voidaan nimetä uudelleen tai ne saattavat poistua käytöstä (--kds-c--alkuiset muuttujat). |
Komponenttien elinkaari
Komponenttien elinkaarta kuvataan seuraavilla tiloilla.
| Tila | Kuvaus |
|---|---|
| Luonnos | Luonnos tai kokeellinen komponentti, joka on tulossa osaksi komponenttivalikoimaa. Rikkovia API-muutoksia voi tulla milloin tahansa. Ominaisuuksissa, selaintuessa tai saavutettavuudessa voi olla isoja puutteita. |
| Beta | Komponentti soveltuu tuotantokäyttöön ja sen käyttöä suositellaan. Ominaisuudet eivät kuitenkaan ole vielä kaikilta osin valmiit, eikä komponenttia ole testattu kattavasti. Rikkovat muutokset ovat mahdollisia, mutta niitä pyritään välttämään. |
| Valmis | Komponentti on todettu vakaaksi ja sitä käytetään jo tuotannossa. Rikkovat muutokset noudattavat julkaisukäytäntöä. Huom! Tila ei näy dokumentaatiossa. |
| Poistuva | Komponentti poistuu käytöstä tulevissa major-versioissa, eikä sen käyttöä enää suositella. Ominaisuuksia ei enää kehitetä. Versiohistoriassa on ilmoitettu versio, jossa komponentti poistuu. |